|
1 |
| -# Welcome to NumPy tutorials |
| 1 | +# NumPy tutorials |
2 | 2 |
|
3 | 3 | [][launch_binder]
|
4 | 4 |
|
5 | 5 | [launch_binder]: http://mybinder.org/v2/gh/numpy/numpy-tutorials/master?urlpath=lab/tree/content
|
6 | 6 |
|
7 |
| -The info from the README.md would be moved/repeated here. |
| 7 | +This set of tutorials and educational materials is being developed, |
| 8 | +IT IS NOT INTEGRATED IN THE HTML DOCS AT <https://www.numpy.org/devdocs/> |
| 9 | + |
| 10 | +The goal of this repository is to provide high-quality resources by the |
| 11 | +NumPy project, both for self-learning and for teaching classes with. If you're |
| 12 | +interested in adding your own content, check the [Contributing](#contributing) |
| 13 | +section. |
| 14 | + |
| 15 | +To open a live version of the content, click the **launch Binder** button above. |
| 16 | +You can also launch individual tutorials on Binder by clicking on the |
| 17 | +rocket icon that appears in the upper-right corner of each tutorial. |
| 18 | +To download a local copy of the `.ipynb` files, you can either |
| 19 | +[clone this repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) |
| 20 | +or use the download icon in the upper-right corner of each tutorial. |
| 21 | + |
| 22 | +## Content |
8 | 23 |
|
9 | 24 | ```{toctree}
|
10 | 25 | ---
|
11 | 26 | maxdepth: 1
|
12 |
| -caption: "Contents:" |
13 | 27 | ---
|
14 | 28 |
|
15 | 29 | content/cs231_tutorial
|
16 | 30 | content/tutorial-svd
|
| 31 | +``` |
| 32 | + |
| 33 | +### Attribution |
| 34 | + |
| 35 | + - The cs231n tutorial is by [@jcjohnson][jj]. The full tutorial in |
| 36 | + its original form is linked via [numpy.org][learn]. |
| 37 | + - The SVD tutorial is by [@melissawm][mwm]. The full tutorial is available |
| 38 | + via the [tutorials page][np_tutorials] of the official NumPy documentation. |
| 39 | + |
| 40 | +[jj]: https://github.com/jcjohnson |
| 41 | +[learn]: https://numpy.org/learn |
| 42 | +[mwm]: https://github.com/melissawm |
| 43 | +[np_tutorials]: https://numpy.org/devdocs/user/tutorials_index.html |
| 44 | + |
| 45 | +## Contributing |
| 46 | + |
| 47 | +We very much welcome contributions! If you have an idea or proposal for a new |
| 48 | +tutorial, please [open an issue](https://github.com/numpy/numpy-tutorials/issues) |
| 49 | +with an outline. |
| 50 | + |
| 51 | +Don’t worry if English is not your first language, or if you can only come up |
| 52 | +with a rough draft. Open source is a community effort. Do your best – we’ll help |
| 53 | +fix issues. |
| 54 | + |
| 55 | +Images and real-life data make text more engaging and powerful, but be sure what |
| 56 | +you use is appropriately licensed and available. Here again, even a rough idea |
| 57 | +for artwork can be polished by others. |
| 58 | + |
| 59 | +### Why Jupyter Notebooks? |
| 60 | + |
| 61 | +The choice of Jupyter Notebook in this repo instead of the usual format |
| 62 | +([reStructuredText][rst]) |
| 63 | +used in the main NumPy documentation has two reasons: |
| 64 | + |
| 65 | + |
| 66 | + * Jupyter notebooks are a common format for communicating scientific |
| 67 | + information. |
| 68 | + * rST may present a barrier for some people who might otherwise be very |
| 69 | + interested in contributing tutorial material. |
| 70 | + |
| 71 | +[rst]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html |
| 72 | + |
| 73 | +### Adding your own tutorials |
| 74 | + |
| 75 | +If you have your own tutorial in the form of a Jupyter notebook (an `.ipynb` |
| 76 | +file) and you'd like to try add it out to the repository: |
| 77 | + |
| 78 | +#### Create an issue |
| 79 | + |
| 80 | +Go to <https://github.com/numpy/numpy-tutorials/issues> and create a new issue |
| 81 | +with your proposal. |
| 82 | +Give as much detail as you can about what kind of content you would like to |
| 83 | +write (tutorial, how-to) and what you plan to cover. |
| 84 | +We will try to respond as quickly as possible with comments, if applicable. |
| 85 | + |
| 86 | +#### Check out our suggested template |
| 87 | + |
| 88 | +You can use this template to make your content consistent with our existing |
| 89 | +tutorials: |
| 90 | + |
| 91 | +```{toctree} |
| 92 | +--- |
| 93 | +maxdepth: 1 |
| 94 | +--- |
17 | 95 | content/tutorial-style-guide
|
18 | 96 | ```
|
19 | 97 |
|
| 98 | +#### Upload your content |
| 99 | + |
| 100 | +Remember to clear all outputs on your notebook before uploading it. |
| 101 | + |
| 102 | +<ul> |
| 103 | +<details> |
| 104 | + <summary> |
| 105 | + <b>Fork this repository</b> (if you haven't before). |
| 106 | + </summary> |
| 107 | + <img src="_static/01-fork.gif" width=80% height=80%> |
| 108 | +</details> |
| 109 | + |
| 110 | +<details> |
| 111 | + <summary> |
| 112 | + <b>In your own fork, create a new branch for your content.</b> |
| 113 | + </summary> |
| 114 | + <img src="_static/02-create_new_branch.gif" width=80% height=80%> |
| 115 | +</details> |
| 116 | + |
| 117 | +<details> |
| 118 | + <summary> |
| 119 | + <b>Add your notebook to the <code>content/</code> directory.</b> |
| 120 | + </summary> |
| 121 | + <img src="_static/03-upload.gif" width=80% height=80%> |
| 122 | +</details> |
| 123 | + |
| 124 | +<b>Update the <code>environment.yml</code> file with the dependencies for your tutorial</b> |
| 125 | +(only if you add new dependencies). |
| 126 | + |
| 127 | +<details> |
| 128 | + <summary> |
| 129 | + <b>Update this <code>README.md</code> to include your new entry.</b> |
| 130 | + </summary> |
| 131 | + <img src="_static/04-add_to_readme.gif" width=80% height=80%> |
| 132 | +</details> |
| 133 | + |
| 134 | +<b>Update the attribution section (below) to credit the original tutorial |
| 135 | +author, if applicable.</b> |
| 136 | + |
| 137 | +<details> |
| 138 | + <summary> |
| 139 | + <b>Create a <a href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">pull request.</a></b> |
| 140 | + </summary> |
| 141 | + <img src="_static/05-create_PR.gif" width=80% height=80%> |
| 142 | +</details> |
| 143 | + |
| 144 | +🎉 <b>Wait for review!</b> |
| 145 | +</ul> |
| 146 | + |
| 147 | +For more information about GitHub and its workflow, you can see |
| 148 | +[this document][collab]. |
| 149 | + |
| 150 | +[collab]: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests |
| 151 | + |
| 152 | + |
| 153 | +## Useful links and resources |
| 154 | + |
| 155 | +The following links may be useful: |
| 156 | + |
| 157 | +- [NumPy Code of Conduct](https://numpy.org/doc/stable/dev/conduct/code_of_conduct.html) |
| 158 | +- [Main NumPy documentation](https://numpy.org/doc/stable/) |
| 159 | +- [NumPy documentation team meeting notes](https://hackmd.io/oB_boakvRqKR-_2jRV-Qjg?both) |
| 160 | +- [NEP 44 - Restructuring the NumPy documentation](https://numpy.org/neps/nep-0044-restructuring-numpy-docs.html) |
| 161 | +- [Blog post - Documentation as a way to build Community](https://labs.quansight.org/blog/2020/03/documentation-as-a-way-to-build-community/) |
| 162 | + |
| 163 | +Note that regular documentation issues for NumPy can be found in the [main NumPy |
| 164 | +repository](https://github.com/numpy/numpy/issues) (see the `Documentation` |
| 165 | +labels there). |
| 166 | + |
| 167 | + |
20 | 168 | ## Indices and tables
|
21 | 169 |
|
22 | 170 | * {ref}`genindex`
|
|
0 commit comments