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

Add comments and docstrings to main.py and api.py #68

Closed
wants to merge 2 commits into from

Conversation

sweep-nightly[bot]
Copy link

@sweep-nightly sweep-nightly bot commented Oct 16, 2023

Description

This PR adds comments and docstrings to the main.py and api.py files in the src directory.

Summary of Changes

src/main.py

  • Added a module-level docstring explaining the purpose of the script, which is to define and train a PyTorch model for the MNIST dataset.
  • Added a docstring to the Net class explaining its purpose and its methods.
  • Added comments above each significant block of code to explain their functionality.
  • Added inline comments to clarify any complex lines of code.

src/api.py

  • Added a module-level docstring explaining the purpose of the script, which is to create an API endpoint that uses the trained model to make predictions.
  • Added a docstring to the predict function explaining its functionality, parameters, and return value.
  • Added comments above each significant block of code to explain their functionality.
  • Added inline comments to clarify any complex lines of code.

Please review the changes and merge this PR if everything looks good.

Fixes #11.


🎉 Latest improvements to Sweep:

  • Sweep can now passively improve your repository! Check out Rules to learn more.

💡 To get Sweep to edit this pull request, you can:

  • Comment below, and Sweep can edit the entire PR
  • Comment on a file, Sweep will only modify the commented file
  • Edit the original issue to get Sweep to recreate the PR from scratch

@sweep-nightly
Copy link
Author

sweep-nightly bot commented Oct 16, 2023

Rollback Files For Sweep

  • Rollback changes to src/main.py
  • Rollback changes to src/api.py

@sweep-nightly
Copy link
Author

sweep-nightly bot commented Oct 16, 2023

Apply Sweep Rules to your PR?

  • Apply: All docstrings and comments should be up to date.
  • Apply: Code should be properly formatted and indented.
  • Apply: Variable and function names should be descriptive and follow a consistent naming convention.
  • Apply: Imports should be organized and grouped together.
  • Apply: There should be no unused imports or variables.
  • Apply: Code should be properly commented and include docstrings for functions and classes.

@sweep-nightly sweep-nightly bot added the sweep label Oct 16, 2023
@sweep-nightly sweep-nightly bot closed this Oct 19, 2023
@sweep-nightly sweep-nightly bot deleted the sweep/add-comments-docstrings_7 branch October 19, 2023 05:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sweep: add comments and docstrings to main.py and api.py
0 participants