Lightning-AI/pytorch-lightning

Lightning CLI should use fail_untyped=True

Open

#18,285 opened on Aug 11, 2023

View on GitHub
 (4 comments) (1 reaction) (1 assignee)Python (3,233 forks)batch import
3rd partybreaking changehelp wantedlightningclirefactor

Repository metrics

Stars
 (26,687 stars)
PR merge metrics
 (Avg merge 9d 15h) (3 merged PRs in 30d)

Description

Outline & Motivation

Use fail_untyped=True here https://github.com/Lightning-AI/lightning/blob/97020bf8d7a88ca5195534b8585a5ef53f1ce6cb/src/lightning/pytorch/cli.py#L135 and here https://github.com/Lightning-AI/lightning/blob/97020bf8d7a88ca5195534b8585a5ef53f1ce6cb/src/lightning/pytorch/cli.py#L139

Pitch

I have spent quite a bit of time with the same issue described here https://github.com/Lightning-AI/lightning/issues/15741 . The person there also reported spending "several days". I finally figured it out when I created an isolated example with just jsonargparse which told me "Types as a string and from __future__ import annotations is currently not supported" . That was because CLI has fail_untyped=True by default . I do believe it would be better to have that as default to ease debugging. If not by default, maybe allow users to set that themselves.

I do know that from version 4.22 of jsonargparse this specific example is no longer an issue https://github.com/omni-us/jsonargparse/issues/120 , but my point is more about the general principle of having fail_untyped=True

Additional context

No response

cc @justusschock @awaelchli @borda @carmocca @mauvilsa

Contributor guide

Research direction
Locate the Lightning CLI source code in `src/lightning/pytorch/cli.py` at lines 135 and 139. Add `fail untyped=True` to the `Jsonargparse` calls. Verify by running existing tests and check that the change doesn't break anything. Also check related issues such as #15741 for context.
Tech stack
python
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70