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

[sweep-nightly]

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's functionality and purpose.

Summary of Changes

• In main.py:

  • Added a module-level docstring explaining the purpose of the file.
  • Added a docstring to the Net class explaining its purpose.
  • Added comments to the init method of the Net class explaining the purpose of each layer.
  • Added a docstring to the forward method of the Net class explaining its purpose.
  • Added comments to the forward method explaining the operations being performed.
  • Added comments to the code for loading the MNIST data and normalizing it.
  • Added comments to the code for training the model explaining each step.
  • Added a comment to the code for saving the model explaining the use of the state_dict.

• In api.py:

  • Added a module-level docstring explaining the purpose of the file.
  • Added a comment to the code for loading the model explaining the evaluation mode.
  • Added a comment to the code for defining the transform explaining its purpose.
  • Added a docstring to the predict function explaining its purpose.
  • Added comments to the predict function explaining the preprocessing and prediction steps.

These changes improve the code's 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]

Rollback Files For Sweep

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

[sweep-nightly]

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.