Commit 2daecad8 authored by Benjamin Beyret's avatar Benjamin Beyret
Browse files

update documentation

parent bef88732
......@@ -107,6 +107,10 @@ You can now unzip the content of the archive to the `env` folder and you're read
`AnimalAI.*` is in `env/`. On linux you may have to make the file executable by running `chmod +x env/AnimalAI.x86_64`.
Head over to [Quick Start Guide](documentation/quickstart.md) for a quick overview of how the environment works.
The Unity source files for the environment can be find on the [AnimalAI-Environment repository](https://github.com/beyretb/AnimalAI-Environment).
Due to a lack of resources we cannot provide support on this part of the project at the moment. We recommend reading the documentation on the
[ML-Agents repo](https://github.com/Unity-Technologies/ml-agents) too.
## Manual Control
If you launch the environment directly from the executable or through the VisualizeArena script it will launch in player
......@@ -151,9 +155,6 @@ Deshraj Yadav, Rishabh Jain, Harsh Agrawal, Prithvijit Chattopadhyay, Taranjeet
In play mode pressing `R` or `C` does nothing sometimes. This is due to the fact that we have synchronized these
features with the agent's frames in order to have frames in line with the configuration files for elements such as blackouts. **Solution**: press the key again, several times if needed.
~~When a lot of objects are spawned randomly, extremely rarely, the agent will fall through the floor.~~ (fixed in
v0.6.1)
## TODO
- [x] Add custom resolutions
......@@ -166,6 +167,11 @@ v0.6.1)
## Version History
- v1.0.4
- Adds customisable resolution during evaluation
- Update `animalai-train` to tf 1.14 to fix `gin` broken dependency
- Release source code for the environment (no support to be provided on this for now)
- v1.0.3
- Adds inference mode to Gym environment
- Adds seed to Gym Environment
......
......@@ -11,7 +11,7 @@ We leave participants the task of adapting the information found here to differe
Start by creating an account on [AWS](https://aws.amazon.com/), and then open the [console](https://console.aws.amazon.com/console/home?).
Compute engines on AWS are called `EC2` and offer a vast range of configurations in terms of number and type of CPUs, GPUs,
memory and storage. You can find more details about the different types and prices [here](https://aws.amazon.com/ec2/pricing/on-demand/).
In our case, we will use a `p2.xlarge instance`, in the console select `EC2`:
In our case, we will use a `p2.xlarge` instance, in the console select `EC2`:
![EC2](AWS/EC2.png)
......@@ -34,7 +34,7 @@ and select either `Deep Learning Base AMI (Ubuntu)` if you want a basic Ubuntu i
Click `Next` twice (first Next: Configure Instance Deatils, then Next: Add Storage) and add at least 15 Gb of storage to the current size (so at least 65 total with a default of 50). Click `review and launch`, and then `launch`. You will then be asked to create or select existing key pairs which will be used to ssh to your instance.
Once your instances is started, it will appear on the EC2 console. To ssh into your instance, right click the line, select connect and follow the instructions.
Once your instance is started, it will appear on the EC2 console. To ssh into your instance, right click the line, select connect and follow the instructions.
We can now configure our instance for training. **Don't forget to shutdown your instance once you're done using it as you get charged as long as it runs**.
## Simulating a screen
......@@ -58,7 +58,7 @@ lines to your docker in the `YOUR COMMANDS GO HERE` part, below the line install
```
RUN git clone https://github.com/beyretb/AnimalAI-Olympics.git
RUN pip uninstall --yes tensorflow
RUN pip install tensorflow-gpu==1.12.2
RUN pip install tensorflow-gpu==1.14
RUN apt-get install unzip wget
RUN wget https://www.doc.ic.ac.uk/~bb1010/animalAI/env_linux_v1.0.0.zip
RUN mv env_linux_v1.0.0.zip AnimalAI-Olympics/env/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment