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

Fix train! doc string 404 #1748

Merged
merged 2 commits into from
Oct 17, 2021
Merged

Fix train! doc string 404 #1748

merged 2 commits into from
Oct 17, 2021

Conversation

logankilpatrick
Copy link
Member

No description provided.

@logankilpatrick
Copy link
Member Author

Closes #1745

@logankilpatrick
Copy link
Member Author

I think this is right since train! does not actually exist, it is https://fluxml.ai/Flux.jl/stable/training/training/#Flux.Optimise.train!

@logankilpatrick
Copy link
Member Author

From the Documenter.jl docs:

Note that depending on what the CurrentModule is set to, a docstring @ref may need to be prefixed by the module which defines it.

@DhairyaLGandhi
Copy link
Member

DhairyaLGandhi commented Oct 16, 2021 •
edited
Loading

It should be exported from the Optimise submodule, and therefor in the Flux namespace. Either way, we can include this for the time being.

DhairyaLGandhi
DhairyaLGandhi previously approved these changes Oct 16, 2021
View reviewed changes
docs/src/models/overview.md Outdated Show resolved Hide resolved
@logankilpatrick logankilpatrick mentioned this pull request Oct 16, 2021
Open
DhairyaLGandhi
DhairyaLGandhi approved these changes Oct 16, 2021
View reviewed changes
Copy link
Member

@DhairyaLGandhi DhairyaLGandhi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bors r+

bors bot added a commit that referenced this pull request Oct 16, 2021
@bors @logankilpatrick
Merge #1748
0793364 
1748: Fix `train!` doc string 404 r=DhairyaLGandhi a=logankilpatrick



Co-authored-by: Logan Kilpatrick <[email protected]>
@DhairyaLGandhi
Copy link
Member

Thanks for catching this!

@bors
Copy link
Contributor

bors bot commented Oct 16, 2021

Build failed:

@DhairyaLGandhi
Copy link
Member

bors r+

@bors
Copy link
Contributor

bors bot commented Oct 17, 2021

Build succeeded:

@bors bors bot merged commit ec8def6 into master Oct 17, 2021
@CarloLucibello CarloLucibello deleted the logankilpatrick-patch-3 branch April 7, 2022 07:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DhairyaLGandhi DhairyaLGandhi DhairyaLGandhi approved these changes

Assignees
No one assigned
Labels
hacktoberfest-accepted
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@logankilpatrick @DhairyaLGandhi