Project Title is a template for a data science project README. The 'what' of the project is concisely described here.
This is a more detailed description of Project Title. Go further here in explaining the purpose and process behind the creation of this project. Discuss the programs, APIs, libraries, and data sets used. Describe the structure of the data sets as well. With that context, go into the broader 'why' of the project. Then finally explain the project's current status and maintenance.
List all programs, APIs, and non-csv files used in this project.
This code depends on the following libraries:
pandas
numpy
matplotlib.pyplot
seaborn
In addition to these, the Jupyter Notebook assumes that the data set from it's source has been downloaded, extracted, and saved as name_of_data_file.csv
.
The Binder badge above can be used to explore an executable environment for this project. Note that this template badge links to the Google homepage.
Here is where a more comprehensive summary of the findings of the project go. First reiterate 'what' the project does, then go into detail about 'how' it does that.
include code samples when relevant
Finally, complete this section with another, more contextualized explanation of the broader 'why' of the project, as well as limitations and further possibilities for it.
- this is a list of issues
- and bugs in the project
- as well as a to-do list
- for what needs to be done
- and what steps need to be taken
Any bugs, requests, feedback, pull requests etc. are welcome! For any major changes, please open an issue first to discuss your ideas.
- here's where any people who have contributed to this project are mentioned
- as well as any other sources which deserve credit
You can get in touch with me on LinkedIn
give me that choice follow on Github
or email me at deepaksithu@gmail.com.
This project uses the MIT license.