diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d0aa76d340..6bf245b4cf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -17,8 +17,8 @@ Describe the changes made in this PR. ### Checklist - [ ] Added tests that prove my fix is effective or that my feature works -- [ ] Updated the [changelog](https://github.com/Unity-Technologies/ml-agents/blob/master/com.unity.ml-agents/CHANGELOG.md) (if applicable) -- [ ] Updated the [documentation](https://github.com/Unity-Technologies/ml-agents/tree/master/docs) (if applicable) -- [ ] Updated the [migration guide](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Migrating.md) (if applicable) +- [ ] Updated the [changelog](https://github.com/Unity-Technologies/ml-agents/blob/main/com.unity.ml-agents/CHANGELOG.md) (if applicable) +- [ ] Updated the [documentation](https://github.com/Unity-Technologies/ml-agents/tree/main/docs) (if applicable) +- [ ] Updated the [migration guide](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Migrating.md) (if applicable) ### Other comments diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml index 55f0707596..f3941597fe 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/pre-commit.yml @@ -3,7 +3,7 @@ name: pre-commit on: pull_request: push: - branches: [master] + branches: [main] jobs: pre-commit: diff --git a/.github/workflows/publish_pypi.yaml b/.github/workflows/publish_pypi.yaml index ce1479ceff..9bcbbee4bf 100644 --- a/.github/workflows/publish_pypi.yaml +++ b/.github/workflows/publish_pypi.yaml @@ -16,7 +16,7 @@ jobs: package-path: [ml-agents, ml-agents-envs, gym-unity] steps: - - uses: actions/checkout@master + - uses: actions/checkout@main - name: Set up Python 3.7 uses: actions/setup-python@v1 with: diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml index 85124ff5e8..254d35560e 100644 --- a/.github/workflows/pytest.yml +++ b/.github/workflows/pytest.yml @@ -10,7 +10,7 @@ on: - 'test_requirements.txt' - '.github/workflows/pytest.yml' push: - branches: [master] + branches: [main] jobs: pytest: diff --git a/.yamato/com.unity.ml-agents-performance.yml b/.yamato/com.unity.ml-agents-performance.yml index 253395c033..f1f66a2a2d 100644 --- a/.yamato/com.unity.ml-agents-performance.yml +++ b/.yamato/com.unity.ml-agents-performance.yml @@ -20,7 +20,7 @@ Run_Mac_Perfomance_Tests{{ editor.version }}: triggers: cancel_old_ci: true recurring: - - branch: master + - branch: main frequency: daily artifacts: logs: diff --git a/.yamato/com.unity.ml-agents-test.yml b/.yamato/com.unity.ml-agents-test.yml index 903f5429de..de6d12679a 100644 --- a/.yamato/com.unity.ml-agents-test.yml +++ b/.yamato/com.unity.ml-agents-test.yml @@ -60,7 +60,7 @@ all_package_tests: triggers: cancel_old_ci: true recurring: - - branch: master + - branch: main frequency: daily {% for package in packages %} @@ -101,7 +101,7 @@ test_{{ package.name }}_{{ platform.name }}_{{ editor.version }}: cancel_old_ci: true {% if platform.name == "linux" %} expression: | - (pull_request.target eq "master" OR + (pull_request.target eq "main" OR pull_request.target match "release.+") AND NOT pull_request.draft AND (pull_request.changes.any match "com.unity.ml-agents/**" OR diff --git a/.yamato/compressed-sensor-test.yml b/.yamato/compressed-sensor-test.yml index 02034b266a..2962ca7cf1 100644 --- a/.yamato/compressed-sensor-test.yml +++ b/.yamato/compressed-sensor-test.yml @@ -23,7 +23,7 @@ test_compressed_obs_{{ editor.version }}: cancel_old_ci: true {% if editor.extra_test == "sensor" %} expression: | - (pull_request.target eq "master" OR + (pull_request.target eq "main" OR pull_request.target match "release.+") AND NOT pull_request.draft AND (pull_request.changes.any match "com.unity.ml-agents/**" OR diff --git a/.yamato/gym-interface-test.yml b/.yamato/gym-interface-test.yml index 797bba2291..7d4a213fd4 100644 --- a/.yamato/gym-interface-test.yml +++ b/.yamato/gym-interface-test.yml @@ -23,7 +23,7 @@ test_gym_interface_{{ editor.version }}: cancel_old_ci: true {% if editor.extra_test == "gym" %} expression: | - (pull_request.target eq "master" OR + (pull_request.target eq "main" OR pull_request.target match "release.+") AND NOT pull_request.draft AND (pull_request.changes.any match "com.unity.ml-agents/**" OR diff --git a/.yamato/protobuf-generation-test.yml b/.yamato/protobuf-generation-test.yml index fe819a78f1..28b7c667db 100644 --- a/.yamato/protobuf-generation-test.yml +++ b/.yamato/protobuf-generation-test.yml @@ -28,7 +28,7 @@ test_linux_protobuf_generation: triggers: cancel_old_ci: true expression: | - (pull_request.target eq "master" OR + (pull_request.target eq "main" OR pull_request.target match "release.+") AND NOT pull_request.draft AND (pull_request.changes.any match "protobuf-definitions/**" OR diff --git a/.yamato/pytest-gpu.yml b/.yamato/pytest-gpu.yml index f3c4f3f6d0..85cdcef0b1 100644 --- a/.yamato/pytest-gpu.yml +++ b/.yamato/pytest-gpu.yml @@ -16,7 +16,7 @@ pytest_gpu: triggers: cancel_old_ci: true recurring: - - branch: master + - branch: main frequency: daily artifacts: logs: diff --git a/.yamato/python-ll-api-test.yml b/.yamato/python-ll-api-test.yml index b36943980e..fe4d6301c0 100644 --- a/.yamato/python-ll-api-test.yml +++ b/.yamato/python-ll-api-test.yml @@ -25,7 +25,7 @@ test_linux_ll_api_{{ editor.version }}: cancel_old_ci: true {% if editor.extra_test == "llapi" %} expression: | - (pull_request.target eq "master" OR + (pull_request.target eq "main" OR pull_request.target match "release.+") AND NOT pull_request.draft AND (pull_request.changes.any match "com.unity.ml-agents/**" OR diff --git a/.yamato/standalone-build-test.yml b/.yamato/standalone-build-test.yml index 004681d9fc..959bff2097 100644 --- a/.yamato/standalone-build-test.yml +++ b/.yamato/standalone-build-test.yml @@ -22,7 +22,7 @@ test_linux_standalone_{{ editor.version }}: triggers: cancel_old_ci: true expression: | - (pull_request.target eq "master" OR + (pull_request.target eq "main" OR pull_request.target match "release.+") AND NOT pull_request.draft AND (pull_request.changes.any match "com.unity.ml-agents/**" OR diff --git a/.yamato/standalone-build-webgl-test.yml b/.yamato/standalone-build-webgl-test.yml index f4193f8273..4202ffb4cb 100644 --- a/.yamato/standalone-build-webgl-test.yml +++ b/.yamato/standalone-build-webgl-test.yml @@ -18,7 +18,7 @@ test_webgl_standalone_{{ editor_version }}: triggers: cancel_old_ci: true recurring: - - branch: master + - branch: main frequency: weekly artifacts: logs: diff --git a/.yamato/training-backcompat-tests.yml b/.yamato/training-backcompat-tests.yml index 7722d03e89..b9ead7a8db 100644 --- a/.yamato/training-backcompat-tests.yml +++ b/.yamato/training-backcompat-tests.yml @@ -29,7 +29,7 @@ test_mac_backcompat_2020.1: triggers: cancel_old_ci: true recurring: - - branch: master + - branch: main frequency: daily artifacts: logs: diff --git a/.yamato/training-int-tests.yml b/.yamato/training-int-tests.yml index 6671901bb0..67ad8cd31c 100644 --- a/.yamato/training-int-tests.yml +++ b/.yamato/training-int-tests.yml @@ -20,7 +20,7 @@ test_linux_training_int_{{ editor.version }}: triggers: cancel_old_ci: true expression: | - (pull_request.target eq "master" OR + (pull_request.target eq "main" OR pull_request.target match "release.+") AND NOT pull_request.draft AND (pull_request.changes.any match "com.unity.ml-agents/**" OR diff --git a/README.md b/README.md index d9a2bddd9e..80507d9a10 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ descriptions of all these features. [here](https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/docs/Readme.md) to get started with the latest release of ML-Agents.** -The table below lists all our releases, including our `master` branch which is +The table below lists all our releases, including our `main` branch which is under active development and may be unstable. A few helpful guidelines: - The [Versioning page](docs/Versioning.md) overviews how we manage our GitHub releases and the versioning process for each of the ML-Agents components. @@ -69,7 +69,7 @@ under active development and may be unstable. A few helpful guidelines: | **Version** | **Release Date** | **Source** | **Documentation** | **Download** | **Python Package** | **Unity Package** | |:-------:|:------:|:-------------:|:-------:|:------------:|:------------:|:------------:| -| **master (unstable)** | -- | [source](https://github.com/Unity-Technologies/ml-agents/tree/master) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/master/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/master.zip) | -- | -- | +| **main (unstable)** | -- | [source](https://github.com/Unity-Technologies/ml-agents/tree/main) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/main/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/main.zip) | -- | -- | | **Release 13** | **February 17, 2021** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_13)** | **[docs](https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/docs/Readme.md)** | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_13.zip)** | **[0.24.0](https://pypi.org/project/mlagents/0.24.0/)** | **[1.8.0](https://docs.unity3d.com/Packages/com.unity.ml-agents@1.8/manual/index.html)** | | **Release 12** | December 22, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_12) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_12.zip) | [0.23.0](https://pypi.org/project/mlagents/0.23.0/) | [1.7.2](https://docs.unity3d.com/Packages/com.unity.ml-agents@1.7/manual/index.html) | | **Release 11** | December 21, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_11) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_11_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_11.zip) | [0.23.0](https://pypi.org/project/mlagents/0.23.0/) | [1.7.0](https://docs.unity3d.com/Packages/com.unity.ml-agents@1.7/manual/index.html) | diff --git a/com.unity.ml-agents/CHANGELOG.md b/com.unity.ml-agents/CHANGELOG.md index 47aa4074f1..eed974cf1b 100755 --- a/com.unity.ml-agents/CHANGELOG.md +++ b/com.unity.ml-agents/CHANGELOG.md @@ -62,7 +62,7 @@ and this project adheres to - Added a `--torch-device` commandline option to `mlagents-learn`, which sets the default [`torch.device`](https://pytorch.org/docs/stable/tensor_attributes.html#torch.torch.device) used for training. (#4888) - The `--cpu` commandline option had no effect and was removed. Use `--torch-device=cpu` to force CPU training. (#4888) -- The `mlagents_env` API has changed, `BehaviorSpec` now has a `observation_specs` property containing a list of `ObservationSpec`. For more information on `ObservationSpec` see [here](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Python-API.md#behaviorspec). (#4763, #4825) +- The `mlagents_env` API has changed, `BehaviorSpec` now has a `observation_specs` property containing a list of `ObservationSpec`. For more information on `ObservationSpec` see [here](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Python-API.md#behaviorspec). (#4763, #4825) ### Bug Fixes #### com.unity.ml-agents (C#) @@ -128,7 +128,7 @@ discrete actions for shooting. (#4746) #### com.unity.ml-agents (C#) #### ml-agents / ml-agents-envs / gym-unity (Python) - PyTorch trainers are now the default. See the - [installation docs](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Installation.md) for + [installation docs](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Installation.md) for more information on installing PyTorch. For the time being, TensorFlow is still available; you can use the TensorFlow backend by adding `--tensorflow` to the CLI, or adding `framework: tensorflow` in the configuration YAML. (#4517) @@ -137,7 +137,7 @@ discrete actions for shooting. (#4746) #### com.unity.ml-agents / com.unity.ml-agents.extensions (C#) - The Barracuda dependency was upgraded to 1.1.2 (#4571) - Utilities were added to `com.unity.ml-agents.extensions` to make it easier to -integrate with match-3 games. See the [readme](https://github.com/Unity-Technologies/ml-agents/blob/master/com.unity.ml-agents.extensions/Documentation~/Match3.md) +integrate with match-3 games. See the [readme](https://github.com/Unity-Technologies/ml-agents/blob/main/com.unity.ml-agents.extensions/Documentation~/Match3.md) for more details. (#4515) #### ml-agents / ml-agents-envs / gym-unity (Python) - The `action_probs` node is no longer listed as an output in TensorFlow models (#4613). @@ -160,7 +160,7 @@ goes larger than 2^31. Previous Tensorflow checkpoints will become incompatible #### ml-agents / ml-agents-envs / gym-unity (Python) - Added the Random Network Distillation (RND) intrinsic reward signal to the Pytorch trainers. To use RND, add a `rnd` section to the `reward_signals` section of your - yaml configuration file. [More information here](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Training-Configuration-File.md#rnd-intrinsic-reward) (#4473) + yaml configuration file. [More information here](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Training-Configuration-File.md#rnd-intrinsic-reward) (#4473) ### Minor Changes #### com.unity.ml-agents (C#) - Stacking for compressed observations is now supported. An additional setting @@ -279,11 +279,11 @@ first trajectory processed. (#4299) ### Major Changes #### ml-agents / ml-agents-envs / gym-unity (Python) - The Parameter Randomization feature has been refactored to enable sampling of new parameters per episode to improve robustness. The - `resampling-interval` parameter has been removed and the config structure updated. More information [here](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Training-ML-Agents.md). (#4065) + `resampling-interval` parameter has been removed and the config structure updated. More information [here](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Training-ML-Agents.md). (#4065) - The Parameter Randomization feature has been merged with the Curriculum feature. It is now possible to specify a sampler in the lesson of a Curriculum. Curriculum has been refactored and is now specified at the level of the parameter, not the behavior. More information -[here](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Training-ML-Agents.md).(#4160) +[here](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Training-ML-Agents.md).(#4160) ### Minor Changes #### com.unity.ml-agents (C#) diff --git a/com.unity.ml-agents/CONTRIBUTING.md b/com.unity.ml-agents/CONTRIBUTING.md index fe8ddec7f1..579c7fbf25 100644 --- a/com.unity.ml-agents/CONTRIBUTING.md +++ b/com.unity.ml-agents/CONTRIBUTING.md @@ -8,7 +8,7 @@ of guidelines to ensure that your extensions can be easily integrated. ## Communication First, please read through our -[code of conduct](https://github.com/Unity-Technologies/ml-agents/blob/master/CODE_OF_CONDUCT.md), +[code of conduct](https://github.com/Unity-Technologies/ml-agents/blob/main/CODE_OF_CONDUCT.md), as we expect all our contributors to follow it. Second, before starting on a project that you intend to contribute to the @@ -25,7 +25,7 @@ the `Requests` or `Bug` label. ## Git Branches -The master branch corresponds to the most recent version of the project. Note +The main branch corresponds to the most recent version of the project. Note that this may be newer that the [latest release](https://github.com/Unity-Technologies/ml-agents/releases/tag/latest_release). diff --git a/docs/Installation-Anaconda-Windows.md b/docs/Installation-Anaconda-Windows.md index d3f286fd9f..2fb39b0cce 100644 --- a/docs/Installation-Anaconda-Windows.md +++ b/docs/Installation-Anaconda-Windows.md @@ -127,7 +127,7 @@ git clone --branch release_13 https://github.com/Unity-Technologies/ml-agents.gi ``` The `--branch release_13` option will switch to the tag of the latest stable -release. Omitting that will get the `master` branch which is potentially +release. Omitting that will get the `main` branch which is potentially unstable. If you don't want to use Git, you can find download links on the diff --git a/docs/Installation.md b/docs/Installation.md index 39aedf99ce..1687ba8186 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -64,14 +64,14 @@ git clone --branch release_13 https://github.com/Unity-Technologies/ml-agents.gi ``` The `--branch release_13` option will switch to the tag of the latest stable -release. Omitting that will get the `master` branch which is potentially +release. Omitting that will get the `main` branch which is potentially unstable. #### Advanced: Local Installation for Development You will need to clone the repository if you plan to modify or extend the ML-Agents Toolkit for your purposes. If you plan to contribute those changes -back, make sure to clone the `master` branch (by omitting `--branch release_13` +back, make sure to clone the `main` branch (by omitting `--branch release_13` from the command above). See our [Contributions Guidelines](../com.unity.ml-agents/CONTRIBUTING.md) for more information on contributing to the ML-Agents Toolkit. diff --git a/docs/Migrating.md b/docs/Migrating.md index e2fa876a40..0a943a53e0 100644 --- a/docs/Migrating.md +++ b/docs/Migrating.md @@ -70,7 +70,7 @@ folder - The Parameter Randomization feature has been merged with the Curriculum feature. It is now possible to specify a sampler in the lesson of a Curriculum. Curriculum has been refactored and is now specified at the level of the parameter, not the behavior. More information -[here](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Training-ML-Agents.md).(#4160) +[here](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Training-ML-Agents.md).(#4160) ### Steps to Migrate - The configuration format for curriculum and parameter randomization has changed. To upgrade your configuration files, diff --git a/docs/localized/KR/docs/Installation-Anaconda-Windows.md b/docs/localized/KR/docs/Installation-Anaconda-Windows.md index 8d46eaec17..6552b4aa4e 100644 --- a/docs/localized/KR/docs/Installation-Anaconda-Windows.md +++ b/docs/localized/KR/docs/Installation-Anaconda-Windows.md @@ -104,7 +104,7 @@ ml-agents Conda ȯ git clone https://github.com/Unity-Technologies/ml-agents.git ``` - Git ϰ ʴٸ [ũ](https://github.com/Unity-Technologies/ml-agents/archive/master.zip) ٿε ֽϴ. + Git ϰ ʴٸ [ũ](https://github.com/Unity-Technologies/ml-agents/archive/main.zip) ٿε ֽϴ. `UnitySDK` 丮 Ʈ ߰ Ƽ ּ ԵǾ ֽϴ. ϴµ Ǵ [ ȯ](Learning-Environment-Examples.md) ֽϴ. diff --git a/docs/localized/RU/README.md b/docs/localized/RU/README.md index 2854de781c..85d0766521 100644 --- a/docs/localized/RU/README.md +++ b/docs/localized/RU/README.md @@ -1,4 +1,4 @@ - + # Unity ML-Agents Toolkit Version Release 7 @@ -61,7 +61,7 @@ Proximal Policy Optimization (PPO) и Soft Actor-Critic (SAC). Первый ал См. [здесь](https://github.com/Unity-Technologies/ml-agents/tree/release_7_docs/docs/Readme.md), чтобы начать работать с самой последней версий ML-Agents.** -Таблица внизу - список всех наших релизов, включая master ветку, над которой мы ведем активную работу +Таблица внизу - список всех наших релизов, включая main ветку, над которой мы ведем активную работу и которая может быть нестабильной. Полезная информация: [Управление версиями](docs/Versioning.md) - описание того, как мы работам с GitHub. @@ -72,7 +72,7 @@ Proximal Policy Optimization (PPO) и Soft Actor-Critic (SAC). Первый ал | **Version** | **Дата релиза** | **Source** | **Документация** | **Загрузка** | |:-------:|:------:|:-------------:|:-------:|:------------:| -| **master (unstable)** | -- | [source](https://github.com/Unity-Technologies/ml-agents/tree/master) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/master/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/master.zip) | +| **main (unstable)** | -- | [source](https://github.com/Unity-Technologies/ml-agents/tree/main) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/main/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/main.zip) | | **Release 7** | **16 Сентября, 2020** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_7)** | **[docs](https://github.com/Unity-Technologies/ml-agents/tree/release_7_docs/docs/Readme.md)** | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_7.zip)** | | **Release 6** | 12 Августа, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_6) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_6_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_6.zip) | | **Release 5** | 31 Июля, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_5) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_5_docs/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_5.zip) | diff --git "a/docs/localized/RU/docs/\320\235\320\260\321\207\320\260\320\273\320\276 \321\200\320\260\320\261\320\276\321\202\321\213.md" "b/docs/localized/RU/docs/\320\235\320\260\321\207\320\260\320\273\320\276 \321\200\320\260\320\261\320\276\321\202\321\213.md" index 0eb1052b47..ce6182c98b 100644 --- "a/docs/localized/RU/docs/\320\235\320\260\321\207\320\260\320\273\320\276 \321\200\320\260\320\261\320\276\321\202\321\213.md" +++ "b/docs/localized/RU/docs/\320\235\320\260\321\207\320\260\320\273\320\276 \321\200\320\260\320\261\320\276\321\202\321\213.md" @@ -1,16 +1,16 @@ # Начало работы -В данной статье мы разберем шаг за шагом один из [наших примеров](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Learning-Environment-Examples.md), +В данной статье мы разберем шаг за шагом один из [наших примеров](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Learning-Environment-Examples.md), обучим в нем искусственный интеллект (агента - Agent) и применим полученную модель в Unity сцене (scene). После прочтения статьи, вы сможете обучить агента в любой другой сцене из наших примеров. Если вы не работали с движком [Unity](https://unity.com/products), пожалуйста, ознакомьтесь с нашей статьей -[Background: Unity](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Background-Unity.md). +[Background: Unity](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Background-Unity.md). Также, если словосочетание “машинное обучение” вам ничего не говорит, прочтите для быстрого ознакомления о нем здесь -[Background: Machine Learning](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Background-Machine-Learning.md). +[Background: Machine Learning](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Background-Machine-Learning.md). -![Головы с мячами](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/images/balance.png) +![Головы с мячами](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/images/balance.png) Нашей сценой будет **3D Balance Ball**. Агенты в ней - синие кубы-платформы, у каждого на голове по мячу. Все они - копии друг друга. Каждый куб-агент пытается @@ -24,7 +24,7 @@ ## Установка Если вы еще не установили ML-Agents, следуйте этой -инструкции по установке(https://github.com/Unity-Technologies/ml-agents/tree/master/docs/localized/RU/docs/Установка.md). +инструкции по установке(https://github.com/Unity-Technologies/ml-agents/tree/main/docs/localized/RU/docs/Установка.md). 1. Далее, откройте в Unity Project, в котором находятся примеры: 1. Запустите Unity Hub @@ -38,7 +38,7 @@ со _средой_, собирая о ней данные. В Unity, среда это сцена (scene), в которой есть один или более объектов - Агентов, а также, конечно, и другие объекты, с которыми взаимодействует агент. -![Unity-Editor](https://raw.githubusercontent.com/Unity-Technologies/ml-agents/master/docs/images/mlagents-3DBallHierarchy.png) +![Unity-Editor](https://raw.githubusercontent.com/Unity-Technologies/ml-agents/main/docs/images/mlagents-3DBallHierarchy.png) Обратите внимание: В Unity каждый объект сцены - это объект класса GameObject. GameObject это буквально контейнер для всего, что касается объекта: его физики, графики, поведения и пр., @@ -93,7 +93,7 @@ float (с плавающей точкой, например, 3.14), которы ## Запуск заранее обученной (предтренированной) модели Мы включили в свои примеры заранее обученные модели (файлы с расширением `.nn`) -и использовали [Unity Inference Engine](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Unity-Inference-Engine.md), +и использовали [Unity Inference Engine](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Unity-Inference-Engine.md), чтобы запустить их в Unity. В этом разделе мы воспользуемся одной из таких моделей для 3D Ball. @@ -105,12 +105,12 @@ float (с плавающей точкой, например, 3.14), которы Поэтому при необходимости внести изменения в каждую из платформ, вы можете просто изменить сам префаб вместо этого. - ![Platform Prefab](https://raw.githubusercontent.com/Unity-Technologies/ml-agents/master/docs/images/platform_prefab.png) + ![Platform Prefab](https://raw.githubusercontent.com/Unity-Technologies/ml-agents/main/docs/images/platform_prefab.png) 1. В окне **Project**, перенесите модель (Model) поведения **3DBall**, находящуюся в `Assets/ML-Agents/Examples/3DBall/TFModels` в свойство `Model` в компоненте `Behavior Parameters (Script)` в окне **Inspector** GameObject’a Agent. - ![3dball learning brain](https://raw.githubusercontent.com/Unity-Technologies/ml-agents/master/docs/images/3dball_learning_brain.png) + ![3dball learning brain](https://raw.githubusercontent.com/Unity-Technologies/ml-agents/main/docs/images/3dball_learning_brain.png) 1. Теперь каждый `Агент` на каждой платформе `3DBall` в окне **Hierarchy** должен содержать модель поведения **3DBall** в `Behavior Parameters`. @@ -196,7 +196,7 @@ INFO:mlagents.trainers: first3DBallRun: 3DBallLearning: Step: 10000. Mean Reward фазы обучения к другой. Это сигнал, что процесс обучения проходит успешно. **Примечание:** Вы можете обучать агента, используя вместо Editor’a исполняемые файлы. -См. инструкцию [Using an Executable](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Learning-Environment-Executable.md). +См. инструкцию [Using an Executable](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Learning-Environment-Executable.md). ### Наблюдение за тренировочным процессом @@ -213,7 +213,7 @@ tensorboard --logdir results (среда/суммарная награда за эпизод), которая должно увеличиваться в процессе обучения, приближаясь к 100 - максимально возможное значение, которого может достигнуть агент. -![Example TensorBoard Run](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/images/mlagents-TensorBoard.png) +![Example TensorBoard Run](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/images/mlagents-TensorBoard.png) ## Внедрение модели в среду Unity @@ -250,9 +250,9 @@ mlagents-learn config/ppo/3DBall.yaml --run-id=first3DBallRun --resume ### Следующие шаги - Для дополнительной информации о ML-Agents Toolkit, - см. [Обзор ML-Agents Toolkit](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/ML-Agents-Overview.md). -- [Создание своих сцен](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Learning-Environment-Create-New.md) + см. [Обзор ML-Agents Toolkit](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/ML-Agents-Overview.md). +- [Создание своих сцен](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Learning-Environment-Create-New.md) для обучения агентов. - Обзор более сложных сред обучения, которые есть в качестве - примера в [ML-Agents - Example Environments](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Learning-Environment-Examples.md) -- Информация про различные опции обучения - [Training ML-Agents](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Training-ML-Agents.md) + примера в [ML-Agents - Example Environments](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Learning-Environment-Examples.md) +- Информация про различные опции обучения - [Training ML-Agents](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Training-ML-Agents.md) diff --git "a/docs/localized/RU/docs/\320\243\321\201\321\202\320\260\320\275\320\276\320\262\320\272\320\260.md" "b/docs/localized/RU/docs/\320\243\321\201\321\202\320\260\320\275\320\276\320\262\320\272\320\260.md" index 463dd1d470..69efb4cc7b 100644 --- "a/docs/localized/RU/docs/\320\243\321\201\321\202\320\260\320\275\320\276\320\262\320\272\320\260.md" +++ "b/docs/localized/RU/docs/\320\243\321\201\321\202\320\260\320\275\320\276\320\262\320\272\320\260.md" @@ -2,19 +2,19 @@ ML-Agents Toolkit состоит из нескольких компонентов: -- Специальный пакет Unity ([`com.unity.ml-agents`](https://github.com/Unity-Technologies/ml-agents/tree/master/com.unity.ml-agents)) +- Специальный пакет Unity ([`com.unity.ml-agents`](https://github.com/Unity-Technologies/ml-agents/tree/main/com.unity.ml-agents)) с Unity C# SDK, который будет интегрирован в Unity сцену. - Три Python пакета: - - ([`mlagents`](https://github.com/Unity-Technologies/ml-agents/tree/master/ml-agents)) - пакет с алгоритмами машинного обучения, + - ([`mlagents`](https://github.com/Unity-Technologies/ml-agents/tree/main/ml-agents)) - пакет с алгоритмами машинного обучения, которые позволяют обучить искусственный интеллект. Большинству пользователей ML-Agents достаточно напрямую установить mlagents. - - ([`mlagents_envs`](https://github.com/Unity-Technologies/ml-agents/tree/master/ml-agents-envs) содержит Python + - ([`mlagents_envs`](https://github.com/Unity-Technologies/ml-agents/tree/main/ml-agents-envs) содержит Python API для взаимодействия с Unity сценой. Этот пакет управляет передачей данных между Unity сценой и алгоритмами машинного обучения, реализованных на Python. Пакет mlagents зависит от mlagents_envs. - - ([`gym_unity`](https://github.com/Unity-Technologies/ml-agents/tree/master/gym-unity)) - позволяет обернуть вашу сцену + - ([`gym_unity`](https://github.com/Unity-Technologies/ml-agents/tree/main/gym-unity)) - позволяет обернуть вашу сцену в Unity в среду OpenAI Gym. -- Unity [Project](https://github.com/Unity-Technologies/ml-agents/tree/master/Project), -содержащий [примеры сцены](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Learning-Environment-Examples.md), +- Unity [Project](https://github.com/Unity-Technologies/ml-agents/tree/main/Project), +содержащий [примеры сцены](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Learning-Environment-Examples.md), где реализованы различные возможности ML-Agents для наглядности. Итого, чтобы установить и использовать ML-Agents, вам нужно: @@ -56,9 +56,9 @@ git clone --branch release_7 https://github.com/Unity-Technologies/ml-agents.git Вам нужно будет склонировать репозиторий, если вы планируете вносить изменения или что-то добавлять в ML-Agents для своих целей. Или вы планируете сделать -эти изменения общедоступными, пожалуйста, склонируйте master branch +эти изменения общедоступными, пожалуйста, склонируйте main branch (без флага `--branch release_7` в команде выше). -Далее см. [гайд про публикацию правок](https://github.com/Unity-Technologies/ml-agents/blob/master/com.unity.ml-agents/CONTRIBUTING.md). +Далее см. [гайд про публикацию правок](https://github.com/Unity-Technologies/ml-agents/blob/main/com.unity.ml-agents/CONTRIBUTING.md). ### Установка пакета `com.unity.ml-agents` для Unity Unity ML-Agents C# SDK это пакет Unity. Вы можете установить его прямо из пакетного менеджера, @@ -82,11 +82,11 @@ Unity Package Manager. Пожалуйста, убедитесь, что вы н А в Unity 2019.3 она - сверху слева.

- Unity Package Manager Window - package.json @@ -102,7 +102,7 @@ Unity Package Manager. Пожалуйста, убедитесь, что вы н Virtual Environments позволяет управлять ранее установленными версиями так, что для одного проекта будут одни зависимости, а для другого - другие на каждой из операционных систем - Mac / Windows / Linux. -Гайд по [Virtual Environments](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Using-Virtual-Environment.md). +Гайд по [Virtual Environments](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Using-Virtual-Environment.md). Чтобы установить `mlagents` Python, активируйте вашу виртуальную среду и выполните следующее в командной строке: @@ -117,8 +117,8 @@ pip3 install mlagents команду `mlagents-learn --help`, после исполнения которой вы увидите набор доступных команд `mlagents-learn`. Устанавливая mlagents, вы также устанавливаете и все то, на базе чего он сделан - -см. [setup.py file](https://github.com/Unity-Technologies/ml-agents/blob/master/ml-agents/setup.py). -В том числе [TensorFlow](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Background-TensorFlow.md) +см. [setup.py file](https://github.com/Unity-Technologies/ml-agents/blob/main/ml-agents/setup.py). +В том числе [TensorFlow](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Background-TensorFlow.md) (требует поддержки CPU w/ AVX). #### Продвинутая локальная установка для разработки @@ -139,15 +139,15 @@ pip3 install -e ./ml-agents ### Следующие шаги -Гайд ["Начало работы"](https://github.com/Unity-Technologies/ml-agents/tree/master/docs/localized/RU/docs/Начало-работы.md) +Гайд ["Начало работы"](https://github.com/Unity-Technologies/ml-agents/tree/main/docs/localized/RU/docs/Начало-работы.md) содержит в себе серию коротких обучающих уроков по настройке ML-Agents внутри Unity и запуск предобученной модели, а также уроки по созданию и дополнению сцен, где будет обучаться ваш агент. ### Помощь -Если у вас возникли трудности с ML-Agents, пожалуйста, обратитесь к [FAQ](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/FAQ.md) -и к странице [Limitations](https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Limitations.md). +Если у вас возникли трудности с ML-Agents, пожалуйста, обратитесь к [FAQ](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/FAQ.md) +и к странице [Limitations](https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Limitations.md). Если это не решило вашу проблему, создайте запрос [здесь](https://github.com/Unity-Technologies/ml-agents/issues), предоставив информацию о операционной системе, версии Python и сообщение об ошибки (если оно есть). diff --git a/ml-agents/setup.py b/ml-agents/setup.py index 30a01a25e2..8b4b593e3b 100644 --- a/ml-agents/setup.py +++ b/ml-agents/setup.py @@ -65,7 +65,7 @@ def run(self): "protobuf>=3.6", "pyyaml>=3.1.0", # Windows ver. of PyTorch doesn't work from PyPi. Installation: - # https://github.com/Unity-Technologies/ml-agents/blob/master/docs/Installation.md#windows-installing-pytorch + # https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Installation.md#windows-installing-pytorch 'torch>=1.6.0,<1.8.0;platform_system!="Windows"', "tensorboard>=1.15", # cattrs 1.1.0 dropped support for python 3.6. diff --git a/utils/make_readme_table.py b/utils/make_readme_table.py index 6ecc6a2ca6..b44b8fd0f5 100644 --- a/utils/make_readme_table.py +++ b/utils/make_readme_table.py @@ -20,7 +20,7 @@ def table_line(version_info, bold=False): f"{bold_str}[docs]({version_info.doc_link}){bold_str}", f"{bold_str}[download]({version_info.download_link}){bold_str}", ] - if version_info.is_master: + if version_info.is_main: cells.append("--") # python cells.append("--") # Unity else: @@ -46,12 +46,12 @@ def loose_version(self) -> LooseVersion: return LooseVersion(self.python_verion) @property - def is_master(self) -> bool: - return self.release_tag == "master" + def is_main(self) -> bool: + return self.release_tag == "main" @property def release_datetime(self) -> datetime: - if self.is_master: + if self.is_main: return datetime.today() return datetime.strptime(self.release_date, "%B %d, %Y") @@ -71,8 +71,8 @@ def display_name(self) -> str: """ if self.is_verified: return f"Verified Package {self.csharp_version}" - elif self.is_master: - return "master (unstable)" + elif self.is_main: + return "main (unstable)" else: return self.release_tag.replace("_", " ").title() @@ -117,7 +117,7 @@ def pypi_link(self): versions = [ - ReleaseInfo("master", "master", "master", "--"), + ReleaseInfo("main", "main", "main", "--"), ReleaseInfo("release_1", "1.0.0", "0.16.0", "April 30, 2020"), ReleaseInfo("release_2", "1.0.2", "0.16.1", "May 20, 2020"), ReleaseInfo("release_3", "1.1.0", "0.17.0", "June 10, 2020"), @@ -144,7 +144,7 @@ def pypi_link(self): highlight_versions.add([v for v in sorted_versions if v.is_verified][0]) # Highlight the most recent regular version highlight_versions.add( - [v for v in sorted_versions if (not v.is_verified and not v.is_master)][0] + [v for v in sorted_versions if (not v.is_verified and not v.is_main)][0] ) count_by_verified = Counter() diff --git a/utils/validate_release_links.py b/utils/validate_release_links.py index 914fa02bb0..52618660b0 100755 --- a/utils/validate_release_links.py +++ b/utils/validate_release_links.py @@ -60,7 +60,7 @@ def git_ls_files() -> List[str]: def get_release_tag() -> Optional[str]: """ Returns the release tag for the mlagents python package. - This will be None on the master branch. + This will be None on the main branch. :return: """ with open(TRAINER_INIT_FILE) as f: