Base content of RL course

Author: ansantam

.gitignore

@@ -0,0 +1,154 @@
+# Windows
+Thumbs.db
+desktop.ini
+*.ppt
+*.pptx
+
+# OS X
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+
+# Flug archives
+*.tar.zst
+*.json
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# virtual environment
+*_env/
+*-train-data/
+# model
+wandb/
+models/
+# data
+data/

README.md

@@ -0,0 +1,119 @@
+# Tutorial on basic neural network concepts
+
+<!-- [![DOI](https://zenodo.org/badge/759758400.svg)](https://zenodo.org/doi/10.5281/zenodo.10792272)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -->
+
+- [Download the repository](#download-the-repository)
+- [Getting started](#getting-started)
+- [Running the tutorial](#running-the-tutorial)
+
+## Material for this tutorial
+
+- The theoretical lecture can be found here:
+  <!-- - [Part 1: Introduction to reinforcement learning](https://github.com/machine-learning-tutorial/neural-networks/blob/main/slides/nns-part1.pdf) -->
+
+- The tutorial in slide form is here
+  <!-- - [Part 1: simple gridworld (no ML libraries)](https://machine-learning-tutorial.github.io/neural-networks/1-neural-networks.html#/) -->
+
+## Download the repository
+
+### Get the repository with Git
+
+You will need to have Git previously installed in your computer.
+To check if you have it installed, open your terminal and type:
+
+``` bash
+git --version
+```
+
+#### Git installation in MacOS
+
+``` bash
+brew update
+brew install git
+```
+
+#### Git installation in Linux
+
+In Ubuntu/Debian
+
+``` bash
+sudo apt install git
+```
+
+In CentOS
+
+``` bash
+sudo yum install git
+```
+
+Once you have Git installed open your terminal, go to your desired directory, and type:
+
+``` bash
+git clone https://github.com/machine-learning-tutorial/reinforcement-learning
+cd reinforcement-learning
+```
+
+## Getting started
+
+You need to install the dependencies before running the notebooks.
+
+### Using conda
+
+If you don't have conda installed already and want to use conda for environment management, you can install the miniconda as [described here](https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html).
+
+- Create a conda env with `conda create -n rl-tutorial python=3.10`
+- Activate the environment with `conda activate rl-tutorial`
+- Install the required packages via `pip install -r requirements.txt`.
+- Run the following commands:
+
+```bash
+python -m jupyter contrib nbextension install --user
+python -m jupyter nbextension enable varInspector/main
+```
+
+- **After the tutorial** you can remove your environment with `conda remove -n nn-tutorial --all`
+
+
+## Running the tutorial
+
+After installing the package
+
+You can start the jupyter notebook in the terminal, and it will start a browser automatically
+
+```bash
+python -m jupyter notebook
+```
+
+Alternatively, you can use supported Editor to run the jupyter notebooks, e.g. with VS Code.
+
+### Jupyter Notebooks
+
+Use `cmd+Enter` to execute one cell block
+
+### Part 1 Simple Gridworld (no ML libraries)
+
+The first part of the tutorial is in `RL_simple_gridworld.ipynb`.
+
+## Citing the tutorial
+
+This tutorial is registered [Zenodo](https://zenodo.org/).
+Please use this DOI when citing this code:
+
+<!-- ```bibtex
+@software{santamaria_garcia_2024_10792273,
+  author       = {Santamaria Garcia, Andrea and
+                  Xu, Chenran},
+  title        = {Tutorial on basic neural network concepts},
+  month        = 03,
+  year         = 2024,
+  publisher    = {Zenodo},
+  version      = {v1.0.1},
+  doi          = {10.5281/zenodo.10792273},
+  url          = {https://doi.org/10.5281/zenodo.10792273}
+}
+``` -->
+
+## Disclaimer
+
+The content of this repository was developed by the [AI4Accelerators team](https://www.ibpt.kit.edu/AI4Accelerators.php) at the [Institute of Beam Physics and Technology (IBPT)](https://www.ibpt.kit.edu/), [Karlsruhe Institute of Technology](https://www.kit.edu/english/).