Skip to content

Improve DataScience project reliability and documentation - #351

Open
dev-javedali wants to merge 11 commits into
codebasics:masterfrom
dev-javedali:fix/datascience-improvements
Open

Improve DataScience project reliability and documentation#351
dev-javedali wants to merge 11 commits into
codebasics:masterfrom
dev-javedali:fix/datascience-improvements

Conversation

@dev-javedali

Copy link
Copy Markdown

Summary

This PR improves the DataScience projects by making the code more reliable and the documentation easier to follow.

Changes

  • Added better input validation and error handling to the Bangalore Home Prices API.
  • Improved file and model path handling in the Flask application.
  • Made the image downloader more reliable with timeouts and error handling.
  • Improved image validation before saving downloaded files.
  • Updated the project README files with clearer setup and usage instructions.
  • Added a CONTRIBUTING.md file for new contributors.
  • Added a .gitignore file for common Python and development files.

Why

These changes make the projects easier to run, understand, and contribute to while fixing a few reliability issues in the existing code.

Testing

  • Reviewed the updated Python files.
  • Checked the documentation and project structure.
  • Kept the changes limited to the DataScience projects.

The second subplot call was commented out along with a leftover line that called set_title() on a plain list, which isn't valid. Uncommented and fixed the expense subplot, added titles for both, and added tight_layout so they don't overlap.
80-100 was listed for both Normal and Diabetic. Based on the bins used later in the notebook ([80,100,125,150]), the diabetic range should be 125-150.
Title read 'US Technolog Stocks' (missing y), and the horizontal bar chart heading closed with <h3> instead of </h3>.
Several notebooks had align=center, style=... with an invalid comma between attributes, inconsistent with the other notebooks in the repo that don't have it.
Fixed a typo in the filename (tutorail -> tutorial) and added PEP8 spacing around the array elements.
Removed the unused 'import sys' statement and added PEP8 spacing around operators, commas, and assignments (e.g. a1=np.arange -> a1 = np.arange, x+y -> x + y).
Heading read 'Fortan style ordering', missing the 'r'. Corrected to 'Fortran style ordering'.
Add a beginner-friendly guide to open source development and contribution. The guide introduces useful Open Source Guides resources and explains how beginners can find projects, fork repositories, create branches, make commits, and open pull requests.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant