This repository contains notebooks from our premium content packages (previously only available through paid susbcription) that is now open-sourced for all developers to enjoy. For more details about us and to see all our free content visit our website
You can contribute by:
- reporting issues that you face when using these notebooks, or
- even better, fixing them and submitting pull requests so that all your peers can enjoy up to date and high quality content, or
- using the content to carry out projects and then add those as additional notebooks for others to use
The majority of the notebooks run PyTorch, but there is also content in good old Python. If you don't feel ready to make a code contribution yet, no problem! You can help by adding documentaiton or openinging new issues; check out the documentation issues.
We will add more details and resources over time to help you contribute more effectively.
- Either create a new issue for a problem you found, or find an existing one that you are interested in addressing.
- Fork this repository to your local GitHub machine. This means that you will have a copy of the repository under your-GitHub-username/repository-name.
- Clone the repository to your local machine using git clone https://github.com/github-username/repository-name.git.
- Create a new branch for your fix using git checkout -b branch-name-here.
- Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
- Use git add insert-paths-of-changed-files-here to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
- Use git commit -m "Insert a short message of the changes made here" to store the contents of the index with a descriptive message.
- Push the changes to the remote repository using git push origin branch-name-here.
- Submit a pull request to the upstream repository.
- Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #4352".
- In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
- Wait for the pull request to be reviewed by a maintainer.
- Make changes to the pull request if the reviewing maintainer recommends them.
- Celebrate your success after your pull request is merged! WAHOO!
If you need help, you can ask questions email us at github@ai.science or join our slack channel.
Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code. See the full code of conduct here