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

Closed
wants to merge 8 commits into from

Conversation

sweep-nightly[bot]
Copy link

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

Description

This PR adds comments and docstrings to the main.py and api.py files in the src directory. The comments and docstrings provide explanations and documentation for the code in these files.

Summary of Changes

main.py

  • Added a docstring at the top of the file to explain the purpose of the file.
  • Added comments above the import statements to explain the purpose of each imported module.
  • Added a comment above the 'transform' variable to explain its purpose in preprocessing the dataset.
  • Added a comment above the 'trainset' variable to explain the MNIST dataset loading process.
  • Added a comment above the 'trainloader' variable to explain the DataLoader function and its parameters.
  • Added a docstring to the 'Net' class to explain its purpose and functionality.

api.py

  • Added a docstring at the top of the file to explain the purpose of the file.
  • Added comments above the import statements to explain the purpose of each imported module.
  • Added a comment above the 'model' variable to explain the model loading process and the model.eval() function.
  • Added a comment above the 'transform' variable to explain its purpose in preprocessing the image.
  • Added a comment above the 'app' variable to explain the FastAPI framework.
  • Added a docstring to the 'predict' function to explain its purpose, parameters, and return value.
  • Added comments within the 'predict' function to explain each step of the image preprocessing and prediction process.

These changes improve the readability and maintainability of the code by providing clear explanations and documentation for each section.

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