{"id":13568497,"url":"https://github.com/Scitator/catalyst-rl-framework","last_synced_at":"2025-04-04T04:31:15.155Z","repository":{"id":88341161,"uuid":"176076700","full_name":"Scitator/catalyst-rl-framework","owner":"Scitator","description":"Catalyst.RL: A Distributed Framework for Reproducible RL Research","archived":false,"fork":false,"pushed_at":"2019-03-17T09:16:43.000Z","size":10,"stargazers_count":38,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-28T16:56:25.774Z","etag":null,"topics":["benchmark","continuous-control","deep-learning","framework","mujoco","python","pytorch","reinforcement-learning"],"latest_commit_sha":null,"homepage":"https://arxiv.org/abs/1903.00027","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-03-17T08:47:14.000Z","updated_at":"2024-05-15T01:35:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"ce50e47a-ab88-4e06-a4f0-21808b1314ca","html_url":"https://github.com/Scitator/catalyst-rl-framework","commit_stats":null,"previous_names":["catalyst-team/catalyst-rl-framework"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scitator%2Fcatalyst-rl-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scitator%2Fcatalyst-rl-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scitator%2Fcatalyst-rl-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Scitator%2Fcatalyst-rl-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Scitator","download_url":"https://codeload.github.com/Scitator/catalyst-rl-framework/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247123072,"owners_count":20887259,"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":["benchmark","continuous-control","deep-learning","framework","mujoco","python","pytorch","reinforcement-learning"],"created_at":"2024-08-01T14:00:26.740Z","updated_at":"2025-04-04T04:31:10.147Z","avatar_url":"https://github.com/Scitator.png","language":"Python","funding_links":[],"categories":["Tools"],"sub_categories":[],"readme":"# Catalyst.RL: A Distributed Framework for Reproducible RL Research\n\n[Paper](https://arxiv.org/abs/1903.00027) \u0026 [Framework](https://github.com/catalyst-team/catalyst)\n\n## Preparation\n\n#### System requirements\n```bash\nsudo apt install -y redis\nsudo apt install -y python3-dev zlib1g-dev libjpeg-dev \\ \n    cmake swig python-pyglet python3-opengl libboost-all-dev \\\n    libsdl2-dev libosmesa6-dev patchelf ffmpeg xvfb\n```\n\n#### Python env setup\n```bash\nconda create -n rl python=3.6 anaconda\nsource activate rl\nconda remove nb_conda_kernels -y\nconda install -c conda-forge nb_conda_kernels -y\nconda install notebook jupyter nb_conda -y\nconda remove nbpresent -y\n```\n\n#### Python requirements\n```bash\npip install gym['all']\npip install -r ./requirements.txt\n```\n\n\n## Examples\n\n#### Local run - LunarLander\n\n```bash\n# terminal 1 - db node\nredis-server --port 12000\n\n# terminal 2 and 3\nexport GPUS=\"\"  # like GPUS=\"0\" or GPUS=\"0,1\" for multi-gpu training\nexport CONFIG=./gym_lunarlander/sac_d3pg.yml  # or \"td3_qd4pg.yml\", \"qd4pg.yml\" \n\n# terminal 2 - trainer node\nCUDA_VISIBLE_DEVICES=\"$GPUS\" catalyst-rl run-trainer --config=\"${CONFIG}\"\n\n# terminal 3 - samplers node\nCUDA_VISIBLE_DEVICES=\"\" catalyst-rl run-samplers --config=\"${CONFIG}\"\n\n# terminal 4 - progress visualization\nCUDA_VISIBLE_DEVICE=\"\" tensorboard --logdir=./logs\n```\n\n\n#### Benchmark - BipedalWalker\n\n```bash\nexport GPUS=\"\"  # like GPUS=\"0\" or GPUS=\"0,1\" for multi-gpu training\nexport EXP_DIR=\"gym_bipedalwalker_simple\"  # or \"gym_bipedalwalker_hardcore\"\nexport CONFIG=./_base/_all.yml,./_base/_agents101.yml,./_base/_qd4pg.yml,./\"${EXP_DIR}\"/qd4pg.yml,./_base/_ddpg.yml\nexport LOGDIR=./logs/\"${EXP_DIR}\"/ddpg-qd4pg\n\nCUDA_VISIBLE_DEVICES=\"$GPUS\" ./bin/grid_run.sh \\\n    --redis-port 12100 \\\n    --config \"$CONFIG\" \\\n    --logdir \"$LOGDIR\" \\\n    --param-name \"shared/n_step\" \\\n    --param-values \"1, 5\" \\\n    --param-type \"int\" \\\n    --wait-time 10800 \\  # 3 hours, use 43200 for 12 hours experiment \n    --n-trials 1  # number of trials per experiment  \n```\n\n\n## Citation\nPlease cite the following paper if you feel this repository useful.\n```\n@article{catalyst_rl,\n  title={Catalyst.RL: A Distributed Framework for Reproducible RL Research},\n  author = {Kolesnikov, Sergey and Hrinchuk, Oleksii},\n  journal={arXiv preprint arXiv:1903.00027},\n  year={2019}\n}\n```\n\n## Related Projects\n\n- [NeurIPS 2018: AI for Prosthetics Challenge](https://github.com/Scitator/neurips-18-prosthetics-challenge): our 3rd place solution for NeurIPS competition based on [Catalyst.RL](https://github.com/catalyst-team/catalyst) \n\n## Contact\nFor any question, please contact\n```bash\nSergey Kolesnikov: scitator@gmail.com\nOleksii Hrinchuk: oleksii.hrinchuk@gmail.com\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FScitator%2Fcatalyst-rl-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FScitator%2Fcatalyst-rl-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FScitator%2Fcatalyst-rl-framework/lists"}