Skip to content

Commit 103bd9f

Browse files
authored
Fixed a number of issues before public announcement (#73)
- Fixed README and index.md wording - Moved images for consistency across binder and html site - Added alt text where appropriate - Moved static images and fixed newline
1 parent 3224fa1 commit 103bd9f

15 files changed

+50
-40
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
# NumPy tutorials
22

3-
This set of tutorials and educational materials is being developed,
4-
IT IS NOT INTEGRATED IN THE HTML DOCS AT https://www.numpy.org/devdocs/
5-
63
The goal of this repository is to provide high-quality resources by the
74
NumPy project, both for self-learning and for teaching classes with. If you're
85
interested in adding your own content, check the [Contributing](#contributing)
9-
section.
6+
section. This set of tutorials and educational materials is not a part of the
7+
NumPy source tree.
108

119
To download a local copy of the `.ipynb` files, you can either
1210
[clone this repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
@@ -26,7 +24,7 @@ or navigate to any of the documents listed below and download it individually.
2624

2725
We very much welcome contributions! If you have an idea or proposal for a new
2826
tutorial, please [open an issue](https://github.com/numpy/numpy-tutorials/issues)
29-
with an outline.
27+
with an outline.
3028

3129
Don’t worry if English is not your first language, or if you can only come up
3230
with a rough draft. Open source is a community effort. Do your best – we’ll help
@@ -39,14 +37,14 @@ for artwork can be polished by others.
3937
The NumPy tutorials are a curated collection of
4038
[MyST-NB](https://myst-nb.readthedocs.io/) notebooks. These notebooks are used
4139
to produce static websites and can be opened as notebooks in Jupyter using
42-
[Jupytext](https://jupytext.readthedocs.io).
40+
[Jupytext](https://jupytext.readthedocs.io).
4341

4442
> __Note:__ You should use [CommonMark](https://commonmark.org) markdown
45-
> cells. Jupyter only renders CommonMark.
43+
> cells. Jupyter only renders CommonMark.
4644
4745
### Why Jupyter Notebooks?
4846

49-
The choice of Jupyter Notebook in this repo instead of the usual format
47+
The choice of Jupyter Notebook in this repo instead of the usual format
5048
([reStructuredText, through Sphinx](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html))
5149
used in the main NumPy documentation has two reasons:
5250

@@ -68,7 +66,7 @@ tutorial](content/pairing.md).
6866
### Adding your own tutorials
6967

7068
If you have your own tutorial in the form of a Jupyter notebook (a `.ipynb`
71-
file) and you'd like to add it to the repository:
69+
file) and you'd like to add it to the repository, follow the steps below.
7270

7371

7472
#### Create an issue
@@ -93,7 +91,7 @@ your content consistent with our existing tutorials.
9391
</summary>
9492
<img src="site/_static/01-fork.gif" width=80% height=80%>
9593
</details>
96-
94+
9795
<details>
9896
<summary>
9997
<b>In your own fork, create a new branch for your content.</b>
@@ -123,7 +121,9 @@ author, if applicable.</b>
123121

124122
<details>
125123
<summary>
126-
<b>Create a <a href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">pull request.</a></b>
124+
<b>Create a <a href="https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests">pull request.</a>
125+
Make sure the "Allow edits and access to secrets by maintainers" option
126+
is selected so we can properly review your submission.</b>
127127
</summary>
128128
<img src="site/_static/05-create_PR.gif" width=80% height=80%>
129129
</details>
@@ -146,4 +146,4 @@ The following links may be useful:
146146

147147
Note that regular documentation issues for NumPy can be found in the [main NumPy
148148
repository](https://github.com/numpy/numpy/issues) (see the `Documentation`
149-
labels there).
149+
labels there).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

content/mooreslaw-tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ kernelspec:
1212
---
1313

1414
# Determining Moore's Law with real data in NumPy
15-
![image.png](01-mooreslaw-tutorial-intro.png)
15+
![Plot of Moore's Law data](_static/01-mooreslaw-tutorial-intro.png)
1616

1717
_The number of transistors reported on a given chip plotted on a log scale in the y axis with the date of introduction on the linear scale x-axis. The blue data points are from a [transistor count table](https://en.wikipedia.org/wiki/Transistor_count#Microprocessors). The red line is an ordinary least squares prediction and the orange line is Moore's law._
1818

content/pairing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,14 +209,14 @@ or the command line:
209209
<summary>
210210
<b>1. Classic Jupyter Jupytext pairing</b>.
211211
</summary>
212-
<img src="01-classic.gif" width=80% height=80%>
212+
<img src="../_static/01-classic.gif" width=80% height=80%>
213213
</details>
214214

215215
<details>
216216
<summary>
217217
<b>2. Jupyter Lab Jupytext pairing</b>
218218
</summary>
219-
<img src="02-jupyterlab.gif" width=80% height=80%>
219+
<img src="../_static/02-jupyterlab.gif" width=80% height=80%>
220220
</details>
221221

222222
<details>

content/tutorial-deep-learning-on-mnist.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Your deep learning model — one of the most basic artificial neural networks th
1919

2020
Based on the image inputs and their labels ([supervised learning](https://en.wikipedia.org/wiki/Supervised_learning)), your neural network will be trained to learn their features using forward propagation and backpropagation ([reverse-mode](https://en.wikipedia.org/wiki/Automatic_differentiation#Reverse_accumulation) differentiation). The final output of the network is a vector of 10 scores — one for each handwritten digit image. You will also evaluate how good your model is at classifying the images on the test set.
2121

22-
![image.png](tutorial-deep-learning-on-mnist.png)
22+
![Diagram showing operations detailed in this tutorial](_static/tutorial-deep-learning-on-mnist.png)
2323

2424
This tutorial was adapted from the work by [Andrew Trask](https://github.com/iamtrask/Grokking-Deep-Learning) (with the author's permission).
2525

@@ -334,7 +334,7 @@ Afterwards, you will construct the building blocks of a simple deep learning mod
334334

335335
Here is a summary of the neural network model architecture and the training process:
336336

337-
![image.png](tutorial-deep-learning-on-mnist.png)
337+
![Diagram showing operations detailed in this tutorial](_static/tutorial-deep-learning-on-mnist.png)
338338

339339
- _The input layer_:
340340

0 commit comments

Comments
 (0)