Skip to content
This repository has been archived by the owner on Jun 9, 2020. It is now read-only.

Latest commit

 

History

History
180 lines (124 loc) · 7.32 KB

windows_submission.md

File metadata and controls

180 lines (124 loc) · 7.32 KB
Raw

AIcrowd-Logo

Flatland submission from Windows

If you are working on windows locally there is a few steps you will need to do in order to make your flatland challenge submission work. Here is a step-by-step instruction on how to achieve this.

Installing WSL

  1. Enable WSL on Windows.
  2. Get Ubuntu for Windows.
  3. Run your Ubuntu system on your computer
  4. Now let us install the Dependencies. From within the Ubuntu-Shell run:

Dependencies

First download Anaconda by running this in the Ubuntu Shell if you are on a 64bit machine, otherwise update link.( ATTENTION: You need the Linux version and not Windows version!!!)

wget https://repo.anaconda.com/archive/Anaconda3-2019.07-Linux-x86_64.sh

Now we can install Anaconda for Ubuntu

chmod +x Anaconda3-2019.07-Linux-x86_64.sh 
 ./Anaconda3-2019.07-Linux-x86_64.sh

For all changes to take affect usually you will have to restart Ubuntu, just close the terminal and run Ubuntu again.

Setup

Setup you ssh keys for your gitlab account by running. You can install in the default directory and use key without password if you like.

ssh-keygen

Now you need to copy your key to your gitlab account. Find the key

cd .ssh
cat id_rsa.pub

Copy all the output and add it to your gitlab keys

Clone your own repository remeber to use ssh cloning and change to the directory where you would like to clone it to! Enter yes when promted. If you don't have an own repository yet, start by cloning the official starter kit

git clone git@gitlab.aicrowd.com:<YOUR_USER_NAME>/flatland-challenge-starter-kit.git

or official starter kit

git clone git@github.com:AIcrowd/flatland-challenge-starter-kit.git
cd flatland-challenge-starter-kit

Create a conda environment from the provided environment.yml

conda env create -f environment.yml

This might take a little bit of time to finish.

Activate the conda environment and install your code specific dependencies

conda activate flatland-rl
# If say you want to install PyTorch
# conda install pytorch torchvision -c pytorch
#
# or you can even use pip to install any additional packages
# for example : 
# pip install -U flatland-rl
# which updates the flatland-rl package to the latest version

How do I specify my software runtime ?

The software runtime is specified by exporting your conda env to the root of your repository by doing :

# The included environment.yml is generated by the command below, and you do not need to run it again
# if you did not add any custom dependencies

conda env export --no-build > environment.yml

# Note the `--no-build` flag, which is important if you want your anaconda env to be replicable across all

This environment.yml file will be used to recreate the conda environment inside the Docker container. This repository includes an example environment.yml

You can specify your software environment by using all the available configuration options of repo2docker. (But please remember to use aicrowd-repo2docker to have GPU support)

What should my code structure be like ?

Please follow the structure documented in the included run.py to adapt your already existing code to the required structure for this round.

Important Concepts

Repository Structure

  • aicrowd.json Each repository should have a aicrowd.json with the following content :
{
  "challenge_id": "aicrowd_flatland_challenge_2019",
  "grader_id": "aicrowd_flatland_challenge_2019",
  "authors": ["your-aicrowd-username"],
  "description": "sample description about your awesome agent",
  "license": "MIT",
  "debug": false
}

If you are not familiar with working in the shell. Use

nano aicrowd.json

to edit the JSON file.

This is used to map your submission to the said challenge, so please remember to use the correct challenge_id and grader_id as specified above.

If you set debug to true, then the evaluation will run on a separate set of 20 environments, and the logs from your submitted code (if it fails), will be made available to you to help you debug. NOTE : IMPORTANT : By default we have set debug:false, so when you have done the basic integration testing of your code, and are ready to make a final submission, please do make sure to set debug to true in aicrowd.json.

Code Entrypoint

The evaluator will use /home/aicrowd/run.sh as the entrypoint, so please remember to have a run.sh at the root, which can instantitate any necessary environment variables, and also start executing your actual code. This repository includes a sample run.sh file. If you are using a Dockerfile to specify your software environment, please remember to create a aicrowd user, and place the entrypoint code at run.sh. If you are unsure what this is all about, you can let run.sh be as is, and instead focus on the run.py which is being called from within run.sh.

Submission

To make a submission, you will have to create a private repository on https://gitlab.aicrowd.com/.

You will have to add your SSH Keys to your GitLab account if you haven't already by following the instructions here. If you do not have SSH Keys, you will first need to generate one.

Then you can create a submission by making a tag push to your repository on https://gitlab.aicrowd.com/. Any tag push (where the tag name begins with "submission-") to your private repository is considered as a submission . Be sure that all changes where added to the commit before pushing. Then you can add the correct git remote, and finally submit by doing :

cd flatland-challenge-starter-kit
# Add AIcrowd git remote endpoint
git remote add aicrowd git@gitlab.aicrowd.com:<YOUR_AICROWD_USER_NAME>/flatland-challenge-starter-kit.git
git push aicrowd master

# Create a tag for your submission and push
git tag -am "submission-v0.1" submission-v0.1
git push aicrowd master
git push aicrowd submission-v0.1

# Note : If the contents of your repository (latest commit hash) does not change,
# then pushing a new tag will **not** trigger a new evaluation.

You now should be able to see the details of your submission at : gitlab.aicrowd.com//<YOUR_AICROWD_USER_NAME>/flatland-challenge-starter-kit/issues

NOTE: Remember to update your username in the link above 😉

In the link above, you should start seeing something like this take shape (the whole evaluation can take a bit of time, so please be a bit patient too 😉 ) :

Best of Luck 🎉 🎉

Author

Sharada Mohanty https://twitter.com/MeMohanty Erik Nygren