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

[Docs] update docs for resume_from_checkpoint #5164

Merged
merged 4 commits into from
Jan 4, 2021
Merged

Conversation

rohitgr7
Copy link
Contributor

@rohitgr7 rohitgr7 commented Dec 16, 2020

What does this PR do?

if resume_from_checkpoint is done using a mid-epoch checkpoint, it resumes from the next epoch. Just added this info here.

Before submitting

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together? Otherwise, we ask you to create a separate PR for every change.
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?
  • Did you verify new and existing tests pass locally with your changes?
  • If you made a notable change (that affects users), did you update the CHANGELOG?

PR review

Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified; Bugfixes should be including in bug-fix release milestones (m.f.X) and features should be included in (m.X.b) releases.

Did you have fun?

Make sure you had fun coding 🙃

@rohitgr7 rohitgr7 added the docs Documentation related label Dec 16, 2020
@rohitgr7 rohitgr7 added this to the 1.1.x milestone Dec 16, 2020
@codecov
Copy link

codecov bot commented Dec 17, 2020

Codecov Report

Merging #5164 (a8799cf) into master (15a400b) will increase coverage by 0%.
The diff coverage is 100%.

@@          Coverage Diff           @@
##           master   #5164   +/-   ##
======================================
  Coverage      93%     93%           
======================================
  Files         134     134           
  Lines        9950    9946    -4     
======================================
- Hits         9261    9260    -1     
+ Misses        689     686    -3     

@rohitgr7 rohitgr7 marked this pull request as ready for review December 17, 2020 05:38
@rohitgr7 rohitgr7 enabled auto-merge (squash) December 24, 2020 07:54
@Borda Borda added the ready PRs ready to be merged label Jan 4, 2021
@rohitgr7 rohitgr7 merged commit dd442b6 into master Jan 4, 2021
@rohitgr7 rohitgr7 deleted the docs/res_frm_ckpt branch January 4, 2021 20:03
Borda pushed a commit that referenced this pull request Jan 6, 2021
* update docs and add pathlib support

* fix

(cherry picked from commit dd442b6)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants