Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit2182c58

Browse files
authored
Merge pull request#39 from melissawm/readme-mistify
Updates the README with content and note about workflow changes.
2 parents58b5203 +d7b7a57 commit2182c58

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

‎README.md

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

3-
[![Binder](http://mybinder.org/badge_logo.svg)](http://mybinder.org/v2/gh/numpy/numpy-tutorials/master?urlpath=lab/tree/content)
4-
53
This set of tutorials and educational materials is being developed,
64
IT IS NOT INTEGRATED IN THE HTML DOCS AThttps://www.numpy.org/devdocs/
75

@@ -10,15 +8,17 @@ NumPy project, both for self-learning and for teaching classes with. If you're
108
interested in adding your own content, check the[Contributing](#contributing)
119
section.
1210

13-
To open a live version of the content, click the**launch Binder** button above.
1411
To download a local copy of the`.ipynb` files, you can either
1512
[clone this repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
1613
or navigate to any of the documents listed below and download it individually.
1714

1815
##Content
1916

20-
1.[Tutorial: Linear algebra on n-dimensional arrays](content/tutorial-svd.ipynb)
21-
2.[Tutorial: CS231n Python Tutorial](content/cs231_tutorial.ipynb)
17+
0.[Learn to write a NumPy tutorial](content/tutorial-style-guide.md): our style guide for writing tutorials.
18+
1.[Tutorial: Linear algebra on n-dimensional arrays](content/tutorial-svd.md)
19+
2.[Tutorial: CS231n Python Tutorial](content/cs231_tutorial.md)
20+
3.[Tutorial: Determining Moore's Law with real data in NumPy](content/mooreslaw-tutorial.ipynb)
21+
4.[Tutorial: Saving and sharing your NumPy arrays](content/save-load-arrays.ipynb)
2222

2323
##Contributing
2424

@@ -45,18 +45,29 @@ used in the main NumPy documentation has two reasons:
4545
* rST may present a barrier for some people who might otherwise be very
4646
interested in contributing tutorial material.
4747

48+
####Note
49+
50+
You may notice that some of our content is in markdown format (`.md` files).
51+
This is part of an ongoing restructuring of the repository workflow. However,
52+
you can still submit your content as a Jupyter Notebook file.
53+
4854
###Adding your own tutorials
4955

5056
If you have your own tutorial in the form of a Jupyter notebook (a`.ipynb`
51-
file) and you'd like totryadd it out to the repository:
57+
file) and you'd like to add it to the repository:
5258

5359
####Create an issue
5460

55-
Go to[https://github.com/numpy/numpy-tutorials/issues](https://github.com/numpy/numpy-tutorials/issues) and create a new issue with your proposal. Give as much detail as you can about what kind of content you would like to write (tutorial, how-to) and what you plan to cover. We will try to respond as quickly as possible with comments, if applicable.
61+
Go to[https://github.com/numpy/numpy-tutorials/issues](https://github.com/numpy/numpy-tutorials/issues)
62+
and create a new issue with your proposal. Give as much detail as you can about
63+
what kind of content you would like to write (tutorial, how-to) and what you
64+
plan to cover. We will try to respond as quickly as possible with comments, if
65+
applicable.
5666

5767
####Check out our suggested template
5868

59-
You can use our[Tutorial Style Guide](content/tutorial-style-guide.ipynb) to make your content consistent with our existing tutorials.
69+
You can use our[Tutorial Style Guide](content/tutorial-style-guide.md) to make
70+
your content consistent with our existing tutorials.
6071

6172
####Upload your content
6273

@@ -84,8 +95,8 @@ Remember to clear all outputs on your notebook before uploading it.
8495
<img src="site/_static/03-upload.gif" width=80% height=80%>
8596
</details>
8697

87-
<b>Update the <code>environment.yml</code> file with the dependencies for your tutorial</b>
88-
(only if you add new dependencies).
98+
<b>Update the <code>environment.yml</code> file with the dependencies for your
99+
tutorial</b>(only if you add new dependencies).
89100

90101
<details>
91102
<summary>

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp