Skip to content

[Documentation] Add documentation and basic doctests to sparseml/core #1742

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
Merged
merged 15 commits into from
Oct 7, 2023
Merged

[Documentation] Add documentation and basic doctests to sparseml/core #1742

merged 15 commits into from
Oct 7, 2023

Conversation

rahul-tuli
Copy link
Member

@rahul-tuli rahul-tuli commented Oct 2, 2023 •
edited
Loading

This PR will add documentation to the newly added classes/methods for the Modifier Refactor Push:

Files to document:

  • src/sparseml/core/init.py
  • src/sparseml/core/data/init.py
  • src/sparseml/core/data/base.py
  • src/sparseml/core/data/pytorch.py
  • src/sparseml/core/event.py
  • src/sparseml/core/factory.py
  • src/sparseml/core/framework.py
  • src/sparseml/core/framework_object.py
  • src/sparseml/core/lifecycle/init.py
  • src/sparseml/core/lifecycle/event.py
  • src/sparseml/core/lifecycle/session.py
  • src/sparseml/core/model/init.py
  • src/sparseml/core/model/base.py
  • src/sparseml/core/model/pytorch.py
  • src/sparseml/core/modifier/init.py
  • src/sparseml/core/modifier/base.py
  • src/sparseml/core/modifier/modifier.py
  • src/sparseml/core/modifier/stage.py
  • src/sparseml/core/optimizer/init.py
  • src/sparseml/core/optimizer/base.py
  • src/sparseml/core/optimizer/pytorch.py
  • src/sparseml/core/recipe/init.py
  • src/sparseml/core/recipe/args.py
  • src/sparseml/core/recipe/base.py
  • src/sparseml/core/recipe/container.py
  • src/sparseml/core/recipe/metadata.py
  • src/sparseml/core/recipe/modifier.py
  • src/sparseml/core/recipe/recipe.py
  • src/sparseml/core/recipe/stage.py
  • src/sparseml/core/session.py
  • src/sparseml/core/state.py

@rahul-tuli rahul-tuli changed the base branch from main to fix/yolov8/sparsezoo_checkpoint October 2, 2023 13:58
@rahul-tuli rahul-tuli changed the base branch from fix/yolov8/sparsezoo_checkpoint to sparsification-refactor October 2, 2023 13:58
@rahul-tuli rahul-tuli self-assigned this Oct 3, 2023
@rahul-tuli rahul-tuli changed the title [feat] Sparsification refactor add documentation [feat][Documentation] Add documentation and basic doctests to sparseml/core Oct 4, 2023
@rahul-tuli rahul-tuli marked this pull request as ready for review October 4, 2023 15:18
@rahul-tuli rahul-tuli changed the title [feat][Documentation] Add documentation and basic doctests to sparseml/core [feat][Documentation] Add documentation and basic doctests to sparseml/core Oct 4, 2023
@rahul-tuli rahul-tuli changed the title [feat][Documentation] Add documentation and basic doctests to sparseml/core [Documentation] Add documentation and basic doctests to sparseml/core Oct 4, 2023
Satrat
Satrat reviewed Oct 4, 2023
View reviewed changes
Copy link

@Satrat Satrat left a comment

Choose a reason for hiding this comment

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

Great work with this so far! Had some comments on making the documentation more clear

@bfineran bfineran mentioned this pull request Oct 4, 2023
Merged
Base automatically changed from sparsification-refactor to main October 4, 2023 19:08
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@rahul-tuli rahul-tuli force-pushed the sparsification-refactor-add-documentation branch from a9bf069 to e99375b Compare October 4, 2023 20:15
@Satrat Satrat self-requested a review October 6, 2023 12:31
Satrat
Satrat previously approved these changes Oct 6, 2023
View reviewed changes
Copy link

@Satrat Satrat left a comment

Choose a reason for hiding this comment

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

LGTM, pending the last few unresolved comments

@rahul-tuli rahul-tuli merged commit 9a6e8e3 into main Oct 7, 2023
@rahul-tuli rahul-tuli deleted the sparsification-refactor-add-documentation branch October 7, 2023 02:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Satrat Satrat Satrat approved these changes

@bfineran bfineran bfineran approved these changes

@markurtz markurtz Awaiting requested review from markurtz

@dsikka dsikka Awaiting requested review from dsikka

@dbogunowicz dbogunowicz Awaiting requested review from dbogunowicz

Assignees

@rahul-tuli rahul-tuli

Labels
mle-team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rahul-tuli @Satrat @bfineran