Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outdated documentation for loggers #1394

Closed
quinor opened this issue Apr 6, 2020 · 3 comments · Fixed by #3916
Closed

Outdated documentation for loggers #1394

quinor opened this issue Apr 6, 2020 · 3 comments · Fixed by #3916
Assignees
Labels
docs Documentation related
Milestone

Comments

@quinor
Copy link
Contributor

quinor commented Apr 6, 2020

Custom logger example doesn't work:
https://pytorch-lightning.readthedocs.io/en/latest/loggers.html#custom-logger

General loggers example doesn't work either due to missing parameters for the loggers.* class constructors:
https://pytorch-lightning.readthedocs.io/en/latest/pytorch_lightning.loggers.html#module-pytorch_lightning.loggers

@quinor quinor added the docs Documentation related label Apr 6, 2020
@stale
Copy link

stale bot commented Jun 5, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the won't fix This will not be worked on label Jun 5, 2020
@Borda
Copy link
Member

Borda commented Jun 10, 2020

@quinor sorry for the delay, mind sending PR with the update? 🐰

@stale stale bot removed the won't fix This will not be worked on label Jun 10, 2020
@Borda Borda added good first issue Good for newcomers let's do it! approved to implement labels Aug 4, 2020
@rbracco
Copy link
Contributor

rbracco commented Sep 25, 2020

I've had a lot of issues with outdated documentation. For instance with lr_find the docs say 2 different things in 2 different places and theyre both wrong. Maybe we could start an effort to overhaul the docs to reflect the latest changes.

The instructions in the trainer section say

# default used by the Trainer (no learning rate finder)
trainer = Trainer(auto_lr_find=False)

# call tune to find the lr
trainer.tune(model)

in the lr_finder section of Common Use Cases they say

model = MyModelClass(hparams)
trainer = Trainer()

# Run learning rate finder
lr_finder = trainer.tuner.lr_find(model)

# Results can be found in
lr_finder.results

# Plot with
fig = lr_finder.plot(suggest=True)
fig.show()

but neither work. It turns out lr_find is currently broken because it doesnt accept a datamodule and theres a fix in progress #3425

@edenlightning edenlightning self-assigned this Oct 2, 2020
@edenlightning edenlightning modified the milestones: 0.9.x, 1.0 Oct 2, 2020
@edenlightning edenlightning removed Hacktoberfest let's do it! approved to implement good first issue Good for newcomers labels Oct 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants