Create ML-Agents Package #3267

surfnerd · 2020-01-22T01:20:41Z

Convert the UnitySDK to a Packman Package

Separate Examples into a sample project.
Move core UnitySDK Code into com.unity.ml-agents.
Create asmdefs for the ml-agents package.
Add package validation tests for win/linux/max.
Update protobuf generation scripts.
Add Barracuda as a package dependency for ML-Agents. (users no longer have to install it themselves).

Things to follow up on:

Package Documentation.
- Remove template documentation.
- Add Proper package docs.
Change current installation documentation.
Update all references to UnitySDK and/or Examples to point to the right places.
Update cloudbuild configurations to point to the project folder.

Project/Packages/manifest.json

com.unity.ml-agents/Tests/Runtime/Unity.ML-Agents.Tests.asmdef

surfnerd · 2020-01-23T17:29:42Z

config/gail_config.yaml

@@ -32,7 +32,7 @@ Pyramids:
    max_steps: 5.0e5
    num_epoch: 3
    behavioral_cloning:
-        demo_path: UnitySDK/Assets/ML-Agents/Examples/Pyramids/Demos/ExpertPyramid.demo
+        demo_path: Project/Assets/ML-Agents/Examples/Pyramids/Demos/ExpertPyramid.demo


All demo files are now in the Project folder. Should we put them in the Samples section of the package?

surfnerd · 2020-01-23T17:30:13Z

docs/Learning-Environment-Create-New.md

@@ -38,14 +38,16 @@ importing the ML-Agents assets into it:

 1. Launch the Unity Editor and create a new project named "RollerBall".
 2. Make sure that the Scripting Runtime Version for the project is set to use
-    **.NET 4.x Equivalent** (This is an experimental option in Unity 2017,
+    **.NET 4.x Equivalent** (This s an experimental option in Unity 2017,


not sure how this happened.

mv -R --lossy?

surfnerd · 2020-01-24T21:23:26Z

com.unity.ml-agents/Runtime/Grpc/GrpcExtensions.cs

@@ -6,6 +6,9 @@
 using MLAgents.CommunicatorObjects;
 using MLAgents.Sensor;
 using UnityEngine;
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("Unity.ML-Agents.Editor")]


Makes the assembly that this file is in internally visible to the Editor assembly.

protobuf-definitions/make.sh

com.unity.ml-agents/CONTRIBUTING.md

com.unity.ml-agents/Documentation~/test-package-guide.md

chriselion

Looks good!

harperj

Echo @chriselion's sentiment about removing or changing the placeholder documentation files, but otherwise this PR LGTM

surfnerd · 2020-01-27T23:56:56Z

com.unity.ml-agents/Tests/Editor/Unity.ML-Agents.Editor.Tests.asmdef

+    "allowUnsafeCode": false,
+    "overrideReferences": true,
+    "precompiledReferences": [
+        "System.IO.Abstractions.dll",


do we actually need these? Is this to help with platform filesystems?

.yamato/com.unity.ml-agents-pack.yml

vincentpierre · 2020-01-27T23:54:37Z

README.md

@@ -73,7 +73,7 @@ In addition to our own documentation, here are some additional, relevant article

 The ML-Agents toolkit is an open-source project and we encourage and welcome
 contributions. If you wish to contribute, be sure to review our
-[contribution guidelines](CONTRIBUTING.md) and
+[contribution guidelines](com.unity.ml-agents/CONTRIBUTING.md) and


Does CONTRIBUTING.md only concerns the package? Do we need another contributing doc for the Examples ?

My thinking was we would link to this one since it's required for packages. But we could just copy it instead of linking it. What do you think?

vincentpierre · 2020-01-27T23:55:36Z

com.unity.ml-agents/CONTRIBUTING.md

@@ -7,7 +7,7 @@ of guidelines to ensure that your extensions can be easily integrated.

 ## Communication

-First, please read through our [code of conduct](CODE_OF_CONDUCT.md), as we
+First, please read through our [code of conduct](https://github.com/Unity-Technologies/ml-agents/blob/master/CODE_OF_CONDUCT.md), as we


I think this will eventually break, we should try to use relative locations for the documentation.

A package will be created from this and a relative path won't make sense once that happens, hence the full URL.

com.unity.ml-agents/LICENSE.md

vincentpierre · 2020-01-28T00:05:09Z

com.unity.ml-agents/Tests/Runtime/Unity.ML-Agents.Tests.asmdef

+{
+    "name": "Unity.ML-Agents.Tests",
+    "references": [
+        "Unity.ML-Agents",


Is it okay to have - in the name? Would Unity.MLAgents be better ?

I don't think it matters, what do you prefer?

vincentpierre · 2020-01-28T00:06:30Z

docs/localized/KR/README.md

@@ -54,7 +54,7 @@ ML-Agents toolkit은 유니티의 풍부한 환경에서 인공지능 에이전
 ## 커뮤니티 그리고 피드백

 ML-Agents toolkit은 오픈소스 프로젝트이며 컨트리뷰션을 환영합니다. 만약 컨트리뷰션을 원하시는 경우
-[컨트리뷰션 가이드라인](CONTRIBUTING.md)과 [행동 규칙](CODE_OF_CONDUCT.md)을 검토해주십시오.


The localized documentation is frozen and should not change. It is tied to a specific version.

That would make sense if the links were tied to that specific version, but they are not. Do you want me to revert those changes?

… to Unity.ML-Agents.Editor.

…espace.

…arty dlls as needed.

…nt there instead.

…kage validation checks.

Parktaeryang · 2020-03-31T16:45:58Z

How to install Grpc.Tools-Version1.14.1 into specific directory( $MLAGENTS_ROOT\protobuf-definitions)using Anaconda3??
I don't know the command Nuget and pip. What should I use and do???
That is only things I have to do. Please help me

Navigate to your installation of nuget and run the following:

nuget install Grpc.Tools -Version 1.14.1 -OutputDirectory $MLAGENTS_ROOT\protobuf-definitions

surfnerd self-assigned this Jan 22, 2020

surfnerd closed this Jan 22, 2020

surfnerd force-pushed the master-create-package branch from 7e3d470 to a591234 Compare January 22, 2020 19:24

surfnerd reopened this Jan 22, 2020

chriselion reviewed Jan 23, 2020

View reviewed changes

Project/Packages/manifest.json Show resolved Hide resolved

surfnerd commented Jan 23, 2020

View reviewed changes

com.unity.ml-agents/Tests/Runtime/Unity.ML-Agents.Tests.asmdef Show resolved Hide resolved

surfnerd commented Jan 23, 2020

View reviewed changes

surfnerd commented Jan 24, 2020

View reviewed changes

protobuf-definitions/make.sh Show resolved Hide resolved

surfnerd force-pushed the master-create-package branch from f22d75b to 663a437 Compare January 24, 2020 23:42

surfnerd marked this pull request as ready for review January 27, 2020 22:48

surfnerd requested review from chriselion, vincentpierre, harperj, Hunter-Unity and ervteng January 27, 2020 22:48

surfnerd force-pushed the master-create-package branch from a86a2c3 to 1aee56c Compare January 27, 2020 22:51

surfnerd requested a review from xiaomaogy January 27, 2020 22:53

chriselion reviewed Jan 27, 2020

View reviewed changes

com.unity.ml-agents/CONTRIBUTING.md Outdated Show resolved Hide resolved

chriselion reviewed Jan 27, 2020

View reviewed changes

com.unity.ml-agents/Documentation~/test-package-guide.md Outdated Show resolved Hide resolved

chriselion approved these changes Jan 27, 2020

View reviewed changes

surfnerd changed the title ~~WIP: Create ML-Agents Package~~ Create ML-Agents Package Jan 27, 2020

harperj approved these changes Jan 27, 2020

View reviewed changes

surfnerd commented Jan 27, 2020

View reviewed changes

vincentpierre reviewed Jan 28, 2020

View reviewed changes

surfnerd force-pushed the master-create-package branch from 2422670 to e7267aa Compare January 28, 2020 00:44

surfnerd added 3 commits January 28, 2020 08:57

First commit of craeting a package.

a4d987d

remove (mostly) all references to 'UnitySDK'.

d9b2723

Fix protobuf generation test.

55d6895

surfnerd added 25 commits January 28, 2020 08:59

Make protobuf files internal. Make Unity.ML-Agents internally visible…

d0a0905

… to Unity.ML-Agents.Editor.

Make windows protobuf script the same as bash. Remove unnecessary nam…

207e6f7

…espace.

Make this visible to the Editor Tests assembly.

2a8b9bc

Add license.

45195f8

update changelog.

2b099ea

Update changelog to reflect version.

78a5a24

Fix linux VM type.

2e6630e

remove trunk test for now.

260f053

add project settings.

5095f9e

Bump Barracua version. Update asmdefs to reference Barrcuda.

907f55a

Move triggers into template so they exist for each job.

b3e2cc7

Move Plugins folder out of Runtime. Update asmdefs to reference 3rd p…

5f1b685

…arty dlls as needed.

Fix asmdef for Edtior test assembly.

5db09a1

Remove duplicate references.

ec0a91f

Comment out COMPILER variable.

0b680b4

Bump up linux flavor due to out of memory error.

531d934

Apply protobuf patch.

fbe5acc

Move CONTRIBUTING.md into com.unity.ml-agents and update links to poi…

59400c4

…nt there instead.

Remove the old csharp test file as those tests are now run in the pac…

8157c9f

…kage validation checks.

Update code of conduct link.

d7fe6b3

Delete template documentation.

5f5a930

Fix link.

5b33b5d

Mirror internal acces for windows protobuf generation.

537f536

Add new line.

daf810d

Resolve conflicts.

b81b87d

surfnerd force-pushed the master-create-package branch from e7267aa to b81b87d Compare January 28, 2020 17:06

surfnerd merged commit a22b62f into master Jan 28, 2020

delete-merged-branch bot deleted the master-create-package branch January 28, 2020 18:35

github-actions bot locked as resolved and limited conversation to collaborators May 15, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create ML-Agents Package #3267

Create ML-Agents Package #3267

surfnerd commented Jan 22, 2020 •

edited

Loading

surfnerd Jan 23, 2020 •

edited

Loading

surfnerd Jan 23, 2020

chriselion Jan 23, 2020

surfnerd Jan 24, 2020

chriselion left a comment

harperj left a comment

surfnerd Jan 27, 2020

vincentpierre Jan 27, 2020

surfnerd Jan 28, 2020

vincentpierre Jan 27, 2020

surfnerd Jan 28, 2020

vincentpierre Jan 28, 2020

surfnerd Jan 28, 2020

vincentpierre Jan 28, 2020

surfnerd Jan 28, 2020

Parktaeryang commented Mar 31, 2020

Create ML-Agents Package #3267

Create ML-Agents Package #3267

Conversation

surfnerd commented Jan 22, 2020 • edited Loading

surfnerd Jan 23, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chriselion left a comment

Choose a reason for hiding this comment

harperj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Parktaeryang commented Mar 31, 2020

surfnerd commented Jan 22, 2020 •

edited

Loading

surfnerd Jan 23, 2020 •

edited

Loading