diff --git a/README.md b/README.md deleted file mode 100644 index b5453a6e..00000000 --- a/README.md +++ /dev/null @@ -1,177 +0,0 @@ -# NumPy tutorials - -_For the rendered tutorials, see https://numpy.org/numpy-tutorials/._ - -The goal of this repository is to provide high-quality resources by the -NumPy project, both for self-learning and for teaching classes with. If you're -interested in adding your own content, check the [Contributing](#contributing) -section. This set of tutorials and educational materials is not a part of the -NumPy source tree. - -To download a local copy of the `.ipynb` files, you can either -[clone this repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) -or navigate to any of the documents listed below and download it individually. - -## Content - -0. [Learn to write a NumPy tutorial](content/tutorial-style-guide.md): our style guide for writing tutorials. -1. [Tutorial: Linear algebra on n-dimensional arrays](content/tutorial-svd.md) -2. [Tutorial: Determining Moore's Law with real data in NumPy](content/mooreslaw-tutorial.md) -3. [Tutorial: Saving and sharing your NumPy arrays](content/save-load-arrays.md) -4. [Tutorial: NumPy deep learning on MNIST from scratch](content/tutorial-deep-learning-on-mnist.md) -5. [Tutorial: X-ray image processing](content/tutorial-x-ray-image-processing.md) -6. [Tutorial: NumPy deep reinforcement learning with Pong from pixels](content/tutorial-deep-reinforcement-learning-with-pong-from-pixels.md) -7. [Tutorial: Masked Arrays](content/tutorial-ma.md) -8. [Tutorial: Static Equilibrium](content/tutorial-static_equilibrium.md) -9. [Tutorial: Plotting Fractals](content/tutorial-plotting-fractals.ipynb) -10. [Tutorial: NumPy natural language processing from scratch with a focus on ethics](content/tutorial-nlp-from-scratch.md) -11. [Tutorial: Analysing the impact of the lockdown on air quality in Delhi, India](content/tutorial-air-quality-analysis.md) - - -## Contributing - -We very much welcome contributions! If you have an idea or proposal for a new -tutorial, please [open an issue](https://github.com/numpy/numpy-tutorials/issues) -with an outline. - -Don’t worry if English is not your first language, or if you can only come up -with a rough draft. Open source is a community effort. Do your best – we’ll help -fix issues. - -Images and real-life data make text more engaging and powerful, but be sure what -you use is appropriately licensed and available. Here again, even a rough idea -for artwork can be polished by others. - -The NumPy tutorials are a curated collection of -[MyST-NB](https://myst-nb.readthedocs.io/) notebooks. These notebooks are used -to produce static websites and can be opened as notebooks in Jupyter using -[Jupytext](https://jupytext.readthedocs.io). - -> __Note:__ You should use [CommonMark](https://commonmark.org) markdown -> cells. Jupyter only renders CommonMark. - -### Why Jupyter Notebooks? - -The choice of Jupyter Notebook in this repo instead of the usual format -([reStructuredText, through Sphinx](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html)) -used in the main NumPy documentation has two reasons: - - * Jupyter notebooks are a common format for communicating scientific - information. - * Jupyter notebooks can be launched in [Binder](https://www.mybinder.org), so that users can interact - with tutorials - * rST may present a barrier for some people who might otherwise be very - interested in contributing tutorial material. - -#### Note - -You may notice our content is in markdown format (`.md` files). We review and -host notebooks in the [MyST-NB](https://myst-nb.readthedocs.io/) format. We -accept both Jupyter notebooks (`.ipynb`) and MyST-NB notebooks (`.md`). If you want -to sync your `.ipynb` to your `.md` file follow the [pairing -tutorial](content/pairing.md). - -### Adding your own tutorials - -If you have your own tutorial in the form of a Jupyter notebook (a `.ipynb` -file) and you'd like to add it to the repository, follow the steps below. - - -#### Create an issue - -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. - -#### Check out our suggested template - -You can use our [Tutorial Style Guide](content/tutorial-style-guide.md) to make -your content consistent with our existing tutorials. - -#### Upload your content - - - -For more information about GitHub and its workflow, you can see -[this document](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests). - - -### Building the Sphinx site locally - -Building the tutorials website, which is published at -https://github.com/numpy/numpy-tutorials, locally isn't necessary before making -a contribution, but may be helpful: - -```bash -conda env create -f environment.yml -conda activate numpy-tutorials -cd site -make html -``` - -## Translations - -While we don't have the capacity to translate and maintain translated versions -of these tutorials, you are free to use and translate them to other languages. - -## Useful links and resources - -The following links may be useful: - -- [NumPy Code of Conduct](https://numpy.org/doc/stable/dev/conduct/code_of_conduct.html) -- [Main NumPy documentation](https://numpy.org/doc/stable/) -- [NumPy documentation team meeting notes](https://hackmd.io/oB_boakvRqKR-_2jRV-Qjg?both) -- [NEP 44 - Restructuring the NumPy documentation](https://numpy.org/neps/nep-0044-restructuring-numpy-docs.html) -- [Blog post - Documentation as a way to build Community](https://labs.quansight.org/blog/2020/03/documentation-as-a-way-to-build-community/) - -Note that regular documentation issues for NumPy can be found in the [main NumPy -repository](https://github.com/numpy/numpy/issues) (see the `Documentation` -labels there). - diff --git a/README_ES.md b/README_ES.md new file mode 100644 index 00000000..d0a8acd6 --- /dev/null +++ b/README_ES.md @@ -0,0 +1,169 @@ +# Tutoriales de NumPy + +_Para ver los tutoriales renderizados, visita https://numpy.org/numpy-tutorials/_. + +El objetivo de este repositorio es proporcionar recursos de alta calidad por parte del +proyecto NumPy, tanto para el autoaprendizaje como para la enseñanza en clases. Si estás +interesado en agregar tu propio contenido, consulta la sección [Contribuir](#contribuir). +Este conjunto de tutoriales y materiales educativos no forma parte del árbol de fuentes de NumPy. + +Para descargar una copia local de los archivos `.ipynb`, puedes +[clonar este repositorio](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) +o navegar a cualquiera de los documentos enumerados a continuación y descargarlos individualmente. + +## Contenido + +0. [Aprende a escribir un tutorial de NumPy](content/tutorial-style-guide.md): nuestra guía de estilo para escribir tutoriales. +1. [Tutorial: Álgebra lineal en matrices n-dimensionales](content/tutorial-svd.md) +2. [Tutorial: Determinando la Ley de Moore con datos reales en NumPy](content/mooreslaw-tutorial.md) +3. [Tutorial: Guardando y compartiendo tus matrices NumPy](content/save-load-arrays.md) +4. [Tutorial: Aprendizaje profundo con NumPy en MNIST desde cero](content/tutorial-deep-learning-on-mnist.md) +5. [Tutorial: Procesamiento de imágenes de rayos X](content/tutorial-x-ray-image-processing.md) +6. [Tutorial: Aprendizaje profundo de refuerzo con NumPy y Pong desde píxeles](content/tutorial-deep-reinforcement-learning-with-pong-from-pixels.md) +7. [Tutorial: Arrays enmascarados](content/tutorial-ma.md) +8. [Tutorial: Equilibrio estático](content/tutorial-static_equilibrium.md) +9. [Tutorial: Trazado de fractales](content/tutorial-plotting-fractals.ipynb) +10. [Tutorial: Procesamiento de lenguaje natural con NumPy desde cero con un enfoque en ética](content/tutorial-nlp-from-scratch.md) +11. [Tutorial: Análisis del impacto del confinamiento en la calidad del aire en Delhi, India](content/tutorial-air-quality-analysis.md) + +## Contribuir + +¡Damos una muy calurosa bienvenida a las contribuciones! Si tienes una idea o propuesta para un nuevo +tutorial, por favor [abre un issue](https://github.com/numpy/numpy-tutorials/issues) +con un esquema. + +No te preocupes si el inglés no es tu primer idioma, o si solo puedes hacer un +borrador aproximado. El código abierto es un esfuerzo comunitario. Haz tu mejor esfuerzo, nosotros +ayudaremos a corregir los problemas. + +Las imágenes y los datos de la vida real hacen que el texto sea más atractivo y poderoso, pero asegúrate de que lo que +utilices tenga la licencia apropiada y esté disponible. Nuevamente, incluso una idea aproximada +de arte puede ser mejorada por otros. + +Los tutoriales de NumPy son una colección curada de +notebooks [MyST-NB](https://myst-nb.readthedocs.io/). Estos notebooks se utilizan +para producir sitios web estáticos y pueden abrirse como notebooks en Jupyter usando +[Jupytext](https://jupytext.readthedocs.io). + +> __Nota:__ Deberías usar celdas en markdown [CommonMark](https://commonmark.org). +> Jupyter solo renderiza CommonMark. + +### ¿Por qué Jupyter Notebooks? + +La elección de Jupyter Notebook en este repositorio en lugar del formato usual +([reStructuredText, a través de Sphinx](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html)) +utilizado en la documentación principal de NumPy tiene dos razones: + + * Los notebooks de Jupyter son un formato común para comunicar información científica. + * Los notebooks de Jupyter pueden ser lanzados en [Binder](https://www.mybinder.org), para que los usuarios puedan interactuar + con los tutoriales. + * rST puede representar una barrera para algunas personas que podrían estar muy + interesadas en contribuir con material tutorial. + +#### Nota + +Puedes notar que nuestro contenido está en formato markdown (archivos `.md`). Revisamos y +alojamos notebooks en el formato [MyST-NB](https://myst-nb.readthedocs.io/). Aceptamos tanto notebooks de Jupyter (`.ipynb`) como notebooks MyST-NB (`.md`). Si deseas +sincronizar tu `.ipynb` con tu archivo `.md`, sigue el [tutorial de emparejamiento](content/pairing.md). + +### Agregar tus propios tutoriales + +Si tienes tu propio tutorial en forma de un notebook de Jupyter (un archivo `.ipynb`) +y deseas agregarlo al repositorio, sigue los pasos a continuación. + +#### Crear un issue + +Ve a [https://github.com/numpy/numpy-tutorials/issues](https://github.com/numpy/numpy-tutorials/issues) +y crea un nuevo issue con tu propuesta. Proporciona tanta información como puedas sobre +el tipo de contenido que te gustaría escribir (tutorial, cómo hacer) y lo que +planeas cubrir. Intentaremos responder lo más rápido posible con comentarios, si +es aplicable. + +#### Consulta nuestra plantilla sugerida + +Puedes usar nuestra [Guía de Estilo de Tutoriales](content/tutorial-style-guide.md) para hacer +tu contenido consistente con nuestros tutoriales existentes. + +#### Sube tu contenido + + + +Para más información sobre GitHub y su flujo de trabajo, puedes ver +[este documento](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests). + +### Construyendo el sitio Sphinx localmente + +Construir el sitio web de tutoriales, que se publica en +https://github.com/numpy/numpy-tutorials, localmente no es necesario antes de hacer +una contribución, pero puede ser útil: + +```bash +conda env create -f environment.yml +conda activate numpy-tutorials +cd site +make html + +## Translations + +While we don't have the capacity to translate and maintain translated versions +of these tutorials, you are free to use and translate them to other languages. + +## Useful links and resources + +The following links may be useful: + +- [NumPy Code of Conduct](https://numpy.org/doc/stable/dev/conduct/code_of_conduct.html) +- [Main NumPy documentation](https://numpy.org/doc/stable/) +- [NumPy documentation team meeting notes](https://hackmd.io/oB_boakvRqKR-_2jRV-Qjg?both) +- [NEP 44 - Restructuring the NumPy documentation](https://numpy.org/neps/nep-0044-restructuring-numpy-docs.html) +- [Blog post - Documentation as a way to build Community](https://labs.quansight.org/blog/2020/03/documentation-as-a-way-to-build-community/) + +Note that regular documentation issues for NumPy can be found in the [main NumPy +repository](https://github.com/numpy/numpy/issues) (see the `Documentation` +labels there). +