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

Projects under the 'Algorithms and Deep Learning Models' directory are missing README files are now added #1475

Merged
merged 9 commits into from
Oct 18, 2024

Conversation

ananas304
Copy link
Contributor

Description

This pull request addresses the issue of missing README files and necessary project documentation under the "Algorithms and Deep Learning Models" directory. In the following projects:

  1. Algorithms and Deep Learning Models/QR-Scanner
  2. Algorithms and Deep Learning Models/Boxoffice
  3. Algorithms and Deep Learning Models/Erasing Clouds from Satellite Imagery

Specifically, the following changes have been made:

  1. Created README.md and requirements.txt files for:
    • Algorithms and Deep Learning Models/QR-Scanner
    • Algorithms and Deep Learning Models/Boxoffice
    • Algorithms and Deep Learning Models/Erasing Clouds from Satellite Imagery
  2. Added detailed project descriptions, setup instructions, and usage examples in each README.md.
  3. Created requirements.txt files for each project, listing all dependencies and libraries required.
  4. For the Boxoffice project:
    • Added the missing .csv file.
    • Fixed code to ensure the project runs without issues.
  5. For the QR-Scanner project:
    • Fixed code to ensure the project runs without issues.

These changes aim to improve the clarity and usability of the projects by providing proper documentation and fixing any missing dependencies.

Motivation: The missing documentation was preventing clear understanding of the projects and how to set them up. The added documentation ensures that future users can easily follow the steps to run these projects.

Fixes #1452

Type of change

  • Added a new machine learning frameworks, libraries or software.
  • Documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Copy link

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

@sanjay-kv sanjay-kv merged commit f5b0d6c into recodehive:main Oct 18, 2024
2 checks passed
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.

📝[Docs]: Projects under the 'Algorithms and Deep Learning Models' directory are missing README files
2 participants