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 #22

Closed
wants to merge 2 commits into from

Conversation

sweep-nightly[bot]
Copy link

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

Description

This PR adds comments and docstrings to the main.py and api.py files in order to improve code readability and maintainability. The comments and docstrings provide explanations and descriptions of the code functionality, imported modules, and data preprocessing steps.

Summary of Changes

main.py

  • Added a module-level docstring explaining the purpose of the file and the steps involved in loading and preprocessing the MNIST dataset.
  • Added comments above the import statements to explain the purpose of each imported module.
  • Added a comment above the 'transform' variable to explain the purpose of the 'transforms.Compose' function and the specific transforms used.
  • Added a comment above the 'trainset' variable to explain the purpose of the 'datasets.MNIST' function and its parameters.
  • Added a comment above the 'trainloader' variable to explain the purpose of the 'DataLoader' function and its parameters.
  • Added a docstring to the 'Net' class to provide an overview of the class and its methods, including a description of the model architecture and the forward pass.

api.py

  • Added a module-level docstring explaining the purpose of the file and the functionality of the FastAPI application.
  • Added comments above the import statements to explain the purpose of each imported module.
  • Added a comment above the 'model' variable to explain the purpose of the 'Net' class and the 'load_state_dict' and 'eval' methods.
  • Added a comment above the 'transform' variable to explain the purpose of the 'transforms.Compose' function and the specific transforms used.
  • Added a docstring to the 'predict' function to provide an overview of the function, including a description of the image preprocessing steps and the model prediction.

These changes improve the code documentation and make it easier for developers to understand and maintain the codebase.

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 12, 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 12, 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 12, 2023
@sweep-nightly sweep-nightly bot closed this Oct 12, 2023
@sweep-nightly sweep-nightly bot deleted the sweep/add-comments-docstrings_3 branch October 12, 2023 23:00
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