{"id":15939967,"url":"https://github.com/scitator/animal-olympics-starter-kit","last_synced_at":"2025-04-03T20:41:30.949Z","repository":{"id":133293788,"uuid":"201295215","full_name":"Scitator/animal-olympics-starter-kit","owner":"Scitator","description":null,"archived":false,"fork":false,"pushed_at":"2019-08-11T06:15:10.000Z","size":10,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-03T11:54:54.240Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Scitator.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-08-08T16:18:04.000Z","updated_at":"2022-01-13T15:33:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"a7d24937-ff03-4d87-8c63-a0001cb48df7","html_url":"https://github.com/Scitator/animal-olympics-starter-kit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scitator%2Fanimal-olympics-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scitator%2Fanimal-olympics-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scitator%2Fanimal-olympics-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scitator%2Fanimal-olympics-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Scitator","download_url":"https://codeload.github.com/Scitator/animal-olympics-starter-kit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247078764,"owners_count":20879949,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-07T06:22:26.555Z","updated_at":"2025-04-03T20:41:30.925Z","avatar_url":"https://github.com/Scitator.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [NeurIPS 2019: Animal-AI Olympics](http://animalaiolympics.com) \u003cbr/\u003e [Catalyst](https://github.com/catalyst-team/catalyst) starter kit\n\n## Environment setup.\n(Taken from the official [repo](https://github.com/beyretb/AnimalAI-Olympics)).\n\nThe Animal-AI package works on Linux, Mac and Windows, as well as most Cloud providers. \nNote that for submission to the competition we only support linux-based Docker files.  \n\u003c!--, for cloud engines check out [this cloud documentation](documentation/cloud.md).--\u003e\n\nWe recommend using a virtual environment specifically for the competition. You will need `python3.6` installed (we currently only support **python3.6**).\n\nThe main package is an API for interfacing with the Unity environment. \nIt contains both a  [gym environment](https://github.com/openai/gym) as well as an extension of Unity's \n[ml-agents environments](https://github.com/Unity-Technologies/ml-agents/tree/master/ml-agents-envs). \nYou can install it via pip:\n    ```\n    pip install animalai\n    ```\n    Or you can install it from the source, head to `animalai/` folder and run `pip install -e .`\n\nAdditionally download the environment for your system:\n\n| OS | Environment link |\n| --- | --- |\n| Linux |  [download v1.0.0](https://www.doc.ic.ac.uk/~bb1010/animalAI/env_linux_v1.0.0.zip) |\n| MacOS |  [download v1.0.0](https://www.doc.ic.ac.uk/~bb1010/animalAI/env_mac_v1.0.0.zip) |\n| Windows | [download v1.0.0](https://www.doc.ic.ac.uk/~bb1010/animalAI/env_windows_v1.0.0.zip)  |\n\nYou can now unzip the content of the archive to the `assets` folder and you're ready to go! Make sure the executable \n`AnimalAI.*` is in `assets/`. On linux you may have to make the file executable by running `chmod +x assets/AnimalAI.x86_64`. \nHead over to [Quick Start Guide](documentation/quickstart.md) for a quick overview of how the environment works.\n\n\ntl;dr\n```bash\n# system requirements\nsudo apt-get install xvfb redis-server\n\n# python requirements\nconda create -n animal python=3.6 anaconda\nsource activate animal\npip install -r ./requirements.txt\n\n# download and unzip env\n```\n\n\n## Catalyst.RL\n\nTo train agents on the Animal Olympics environment, we can run Catalyst.RL as usual.\n```bash\n# start db node\nredis-server --port 12012\n\n# start trainer node\nexport GPUS=\"\"  # like GPUS=\"0\" or GPUS=\"0,1\" for multi-gpu training\nCUDA_VISIBLE_DEVICES=\"$GPUS\" catalyst-rl run-trainer --config ./configs/_exp_common.yml ./configs/ppo.yml\n\n# start sampler node\nCUDA_VISIBLE_DEVICES=\"\" catalyst-rl run-samplers --config ./configs/_exp_common.yml ./configs/ppo.yml --sampler-id=1\n\n# view tensorboard logs\nCUDA_VISIBLE_DEVICE=\"\" tensorboard --logdir=./logs\n```\n\nFor more information about Catalyst.RL you can check [official repo](https://github.com/catalyst-team/catalyst), [documentaiton](https://catalyst-team.github.io/catalyst/) and [examples](https://github.com/catalyst-team/catalyst/tree/master/examples/rl_gym).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscitator%2Fanimal-olympics-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscitator%2Fanimal-olympics-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscitator%2Fanimal-olympics-starter-kit/lists"}