Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removing the notebooks from the github repository. #3704

Merged
merged 3 commits into from
Mar 30, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions com.unity.ml-agents/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]
### Major Changes
- The Jupyter notebooks have been removed from the repository.

### Minor Changes
- Format of console output has changed slightly and now matches the name of the model/summary directory. (#3630, #3616)
Expand Down
19 changes: 0 additions & 19 deletions docs/Background-Jupyter.md

This file was deleted.

3 changes: 1 addition & 2 deletions docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,7 @@ parameters you can use with `mlagents-learn`.

By installing the `mlagents` package, the dependencies listed in the
[setup.py file](../ml-agents/setup.py) are also installed. These include
[TensorFlow](Background-TensorFlow.md) (Requires a CPU w/ AVX support) and
[Jupyter](Background-Jupyter.md).
[TensorFlow](Background-TensorFlow.md) (Requires a CPU w/ AVX support).

#### Advanced: Installing for Development

Expand Down
5 changes: 0 additions & 5 deletions docs/Learning-Environment-Create-New.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,11 +388,6 @@ from the platform. Note that for more involved debugging, the ML-Agents SDK
includes a convenient Monitor class that you can use to easily display Agent
status information in the Game window.

One additional test you can perform is to first ensure that your environment and
the Python API work as expected using the `notebooks/getting-started.ipynb`
[Jupyter notebook](Background-Jupyter.md). Within the notebook, be sure to set
`env_name` to the name of the environment file you specify when building this
environment.

## Training the Environment

Expand Down
1 change: 1 addition & 0 deletions docs/Migrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The versions can be found in
## Migrating from 0.15 to latest

### Important changes
* The Jupyter notebooks have been removed from the repository.

### Steps to Migrate

Expand Down
3 changes: 1 addition & 2 deletions docs/Python-API.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ As such, it can serve as the basis for developing and evaluating new learning al
The ML-Agents Toolkit Low Level API is a Python API for controlling the simulation
loop of an environment or game built with Unity. This API is used by the
training algorithms inside the ML-Agent Toolkit, but you can also write your own
Python programs using this API. Go [here](../notebooks/getting-started.ipynb)
for a Jupyter Notebook walking through the functionality of the API.
Python programs using this API.

The key objects in the Python API include:

Expand Down
1 change: 0 additions & 1 deletion docs/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
## Installation & Set-up

* [Installation](Installation.md)
* [Background: Jupyter Notebooks](Background-Jupyter.md)
* [Using Virtual Environment](Using-Virtual-Environment.md)

## Getting Started
Expand Down
2 changes: 0 additions & 2 deletions gym-unity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,6 @@ env = UnityEnv(environment_filename, worker_id, use_visual, uint8_visual, multia

The returned environment `env` will function as a gym.

For more on using the gym interface, see our
[Jupyter Notebook tutorial](../notebooks/getting-started-gym.ipynb).

## Limitations

Expand Down
1 change: 0 additions & 1 deletion ml-agents/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ def run(self):
# Test-only dependencies should go in test_requirements.txt, not here.
"grpcio>=1.11.0",
"h5py>=2.9.0",
"jupyter",
"matplotlib",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove matplotlib too?

"mlagents_envs=={}".format(VERSION),
"numpy>=1.13.3,<2.0",
Expand Down
288 changes: 0 additions & 288 deletions notebooks/getting-started-gym.ipynb

This file was deleted.

Loading