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

mark stop, skip, @epochs as deprecated #2027

Merged
merged 5 commits into from
Aug 27, 2022
Merged

Conversation

mcabbott
Copy link
Member

@mcabbott mcabbott commented Jul 27, 2022

Replaces #1913 with the simpler plan to remove these from Flux 0.14.

Closes #1913

@Saransh-cpp
Copy link
Member

Should the occurrences of stop, skip, and @epochs be removed from the docs, or should this wait till they are removed (v0.14)? The doctests are failing due to the deprecation warnings. Should the doctests be removed, or should they be updated with the warnings?

@mcabbott
Copy link
Member Author

That's a good question. I think that:

  • For the dep-warns to be of any use, I guess this must be merged into a 0.13 release.
  • The removal of both the code and the docs should be in 0.14, thus a different PR
  • Possibly the last 0.13 docs should have a warning note added too? That could be this PR.
  • To keep tests passing, maybe this PR should also remove some jldoctest annotations.

@mcabbott
Copy link
Member Author

@Saransh-cpp maybe you know, are the built docs previewed somewhere? Is this !!! note thing going to work?

@Saransh-cpp
Copy link
Member

@mcabbott the previews are only generated if a PR is created from a branch belonging to the root Flux repository (restrictions from Documenter.jl). If the PR is from a branch belonging to the root repository, adding the documentation tag to the PR will trigger the DocBot to comment the generated URL.

@Saransh-cpp
Copy link
Member

Saransh-cpp commented Jul 29, 2022

!!! note works! Tested locally!

@mcabbott mcabbott added this to the v0.14 milestone Aug 20, 2022
@mcabbott
Copy link
Member Author

Ready to merge?

Copy link
Member

@ToucheSir ToucheSir left a comment

Choose a reason for hiding this comment

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

A bit of wordsmithing, but otherwise good to go

src/optimise/train.jl Outdated Show resolved Hide resolved
src/optimise/train.jl Outdated Show resolved Hide resolved
Co-authored-by: Brian Chen <ToucheSir@users.noreply.github.com>
@mcabbott mcabbott merged commit 6c747f3 into FluxML:master Aug 27, 2022
@mcabbott mcabbott deleted the stop_skip_2 branch August 27, 2022 23:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants