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.

Sign up for GitHub

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

Jump to bottom

Formatting issues in metric docs #4908

Closed
s-rog opened this issue Nov 30, 2020 · 2 comments · Fixed by #4837 or #5077
Closed

Formatting issues in metric docs #4908

s-rog opened this issue Nov 30, 2020 · 2 comments · Fixed by #4837 or #5077
Assignees
@s-rog
Labels
docs Documentation related good first issue Good for newcomers help wanted Open to be worked on
Milestone
pl:1.1.x

Comments

@s-rog
Copy link
Contributor

s-rog commented Nov 30, 2020 •
edited
Loading

There are some formatting issues with the arguments (the incorrect blocks and apostrophes). I've yet to go through the whole metrics docs, noting them here as I find them for when I get a chance to fix them or if anyone wants to help!

Incorrect:
https://pytorch-lightning.readthedocs.io/en/latest/metrics.html#f1-func
https://pytorch-lightning.readthedocs.io/en/latest/metrics.html#fbeta-func

Correct examples:
https://pytorch-lightning.readthedocs.io/en/latest/metrics.html#iou-func
(among others)

Related: #4837

Edit:
Also noticed that F1 has an unused beta arg that shouldn't be there (we have fbeta), though that's probably a separate issue.
@s-rog s-rog added help wanted Open to be worked on good first issue Good for newcomers docs Documentation related labels Nov 30, 2020
@s-rog s-rog self-assigned this Nov 30, 2020
@Borda Borda modified the milestones: 1.1, 1.1.x Nov 30, 2020
@tadejsv
Copy link
Contributor

tadejsv commented Nov 30, 2020 •
edited
Loading

When the FBeta "split-off" from #4835 will be merged, this will be fixed

@s-rog s-rog linked a pull request Dec 1, 2020 that will close this issue
Classification metrics overhaul: input formatting standardization (1/n) #4837
Merged
@Borda Borda modified the milestones: 1.1.x, 1.1 Dec 8, 2020
@s-rog s-rog reopened this Dec 11, 2020
@s-rog
Copy link
Contributor Author

s-rog commented Dec 11, 2020 •
edited
Loading

The doc issue and beta in f1 (both metrics class and functional) issues are still present in 1.1

@s-rog s-rog modified the milestones: 1.1, 1.1.x Dec 11, 2020
This was referenced Dec 11, 2020
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@s-rog s-rog

Labels
docs Documentation related good first issue Good for newcomers help wanted Open to be worked on
Projects
None yet
Milestone
pl:1.1.x
3 participants
@Borda @tadejsv @s-rog