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

Updated the tutorial.md and project-structure.md files #189

Merged

Conversation

prachi-0319
Copy link
Contributor

@prachi-0319 prachi-0319 commented Oct 26, 2024

Description

Updated the tutorial.md and project-structure.md files.

Issue Resolved

This PR resolves issue number #174.

Changes Made

Updated the tutorial.md file: Added a new point towards the end which mentions how the contributors need to updated the requirements.txt file timely and check for any version conflicts.
Updated the project-structure.md file: Added new files along with adequate descriptions to the directory layout.

Screenshots or Videos

Screenshot 2024-10-26 at 9 27 27 PM Screenshot 2024-10-26 at 9 27 36 PM

Additional Details

Checklist

  • My code follows the current project structure
  • I have thoroughly reviewed and updated the requirements.txt file to include any new packages
  • The predict.py file includes a properly implemented model_details() function, or the notebook contains this function to print a detailed model report. The model will not be accepted without this function, as it is essential for generating the necessary model details.
  • I have added relevant tests (if necessary).
  • I have added comments in the code where needed.
  • This PR is submitted under Hacktoberfest.
  • This PR is submitted under GirlScript Summer of Code (GSSoC-Extd).

@yashasvini121 yashasvini121 self-requested a review October 27, 2024 03:56
@yashasvini121 yashasvini121 merged commit f6e7575 into yashasvini121:master Oct 27, 2024
1 check passed
@yashasvini121 yashasvini121 linked an issue Oct 27, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Project Structure.md and Tutorial.md
2 participants