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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Plugins doc #12440

Merged
merged 16 commits into from Mar 29, 2022
Merged

Update Plugins doc #12440

merged 16 commits into from Mar 29, 2022

Conversation

kaushikb11
Copy link
Contributor

@kaushikb11 kaushikb11 commented Mar 24, 2022

What does this PR do?

Update Plugins doc with the latest v1.6 changes
also fixes: #12492 and replace training type instances with strategy.

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • 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?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
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

Did you have fun?

Make sure you had fun coding 馃檭

cc @Borda @rohitgr7 @justusschock @kaushikb11 @awaelchli @akihironitta @ananthsub

@kaushikb11 kaushikb11 marked this pull request as ready for review March 29, 2022 05:43
@kaushikb11 kaushikb11 added docs Documentation related plugin labels Mar 29, 2022
@kaushikb11 kaushikb11 added this to the 1.6 milestone Mar 29, 2022
docs/source/extensions/plugins.rst Outdated Show resolved Hide resolved
docs/source/extensions/plugins.rst Outdated Show resolved Hide resolved
docs/source/extensions/plugins.rst Outdated Show resolved Hide resolved
docs/source/extensions/plugins.rst Outdated Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Mar 29, 2022
Copy link
Contributor

@akihironitta akihironitta left a comment

Choose a reason for hiding this comment

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

LGTM! 馃殌

Should we update these occurrences of "training type plugin", too?

$ grep -rnIi "training type" docs/source
...
docs/source/common/trainer.rst:1451:Supports passing different training strategies with aliases (ddp, ddp_spawn, etc) as well as custom training type plugins.
docs/source/common/trainer.rst:1461:.. note:: Additionally, you can pass your custom training type plugins to the ``strategy`` argument.

Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

LGTM !

@kaushikb11 kaushikb11 enabled auto-merge (squash) March 29, 2022 09:58
@kaushikb11 kaushikb11 merged commit a775804 into master Mar 29, 2022
@kaushikb11 kaushikb11 deleted the update/plugins_doc branch March 29, 2022 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related plugin ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wrong usage of DeepSpeedPlugin in doc
6 participants