Skip to content

Commit cd8ce92

Browse files
authored
Updated docs for 0.8.0.preview.4 (#343)
Updated supported Unity version on README and Tutorial Phase 3
2 parents 26bbafe + fc259d0 commit cd8ce92

File tree

5 files changed

+8
-7
lines changed

5 files changed

+8
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[![license badge](https://img.shields.io/badge/license-Apache--2.0-green.svg)](LICENSE.md)
88

99
<img src="https://img.shields.io/badge/unity-2019.4-green.svg?style=flat-square" alt="unity 2019.4">
10-
<img src="https://img.shields.io/badge/unity-2020.2-green.svg?style=flat-square" alt="unity 2020.2">
10+
<img src="https://img.shields.io/badge/unity-2020.3-green.svg?style=flat-square" alt="unity 2020.3">
1111

1212
> com.unity.perception is in active development. Its features and API are subject to significant change as development progresses.
1313
-10.8 KB
Loading
-5.8 KB
Loading
-19.4 KB
Loading

com.unity.perception/Documentation~/Tutorial/Phase3.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ In order to make sure our builds are compatible with Unity Simulation, we need t
7777

7878
Here, you can specify a name for the run, the number of Iterations the Scenario will execute for, and the number of Instances (number of nodes the work will be distributed across) for the run. This window automatically picks the currently active Scene and Scenario to run in Unity Simulation.
7979

80-
* **:green_circle: Action**: Name your run `FirstRun`, set the number of Iterations to `1000`, and Instances to `20`.
80+
* **:green_circle: Action**: Name your run `FirstRun`, set the number of Iterations to `1000`, and Instances to `20`.
81+
* **:green_circle: Action**: If you'd like to use a new random seed for this run of your Scenario, click `Randomize` to generate a new seed.
8182
* **:green_circle: Action**: Click _**Build and Run**_.
8283

8384
> :information_source: You can ignore the ***Optional Configuration*** section for now. This is useful if you plan to specify a configuration for your Scenario (including the Randomizers) that will override the values set in the Scenario UI, in Unity Simulation. To generate a configuration, you can click on the ***Generate JSON Config*** button provided in the ***Inspector*** view of Scenario components.
@@ -162,7 +163,7 @@ Example output:
162163
```
163164
name id creation time
164165
--------------------- ---------------------------------------- ---------------------------
165-
Perception Tutorial acd31956-582b-4138-bec8-6670be150f09 * 2020-09-30T00:33:41+00:00
166+
Perception Tutorial 38baa0d0-a2cd-4ee1-801b-39ca3fc5cbc6 * 2020-09-30T00:33:41+00:00
166167
SynthDet 9ec23417-73cd-becd-9dd6-556183946153 2020-08-12T19:46:20+00:00
167168
```
168169

@@ -190,12 +191,12 @@ MacOS:
190191
An example output with 3 runs would look like this:
191192

192193
```
193-
Active Project ID: acd31956-582b-4138-bec8-6670be150f09
194+
Active Project ID: 38baa0d0-a2cd-4ee1-801b-39ca3fc5cbc6
194195
name id creation time executions
195196
----------- --------- --------------------- -----------------------------------------------
196197
FirstRun 1tLbZxL 2020-10-01 23:17:50 id status created_at
197198
--------- ------------- ---------------------
198-
yegz4WN In_Progress 2020-10-01 23:17:54
199+
ojE8Z20 In_Progress 2020-10-01 23:17:54
199200
Run2 klvfxgT 2020-10-01 21:46:39 id status created_at
200201
--------- ------------- ---------------------
201202
kML3i50 In_Progress 2020-10-01 21:46:42
@@ -208,9 +209,9 @@ As seen above, each run has a name, an ID, a creation time, and a list of execut
208209

209210
You can also obtain a list of all the builds you have uploaded to Unity Simulation using the `usim get builds` command.
210211

211-
You may notice that the IDs seen above for the run named `FirstRun` match those we saw earlier in Unity Editor's _**Console**_. You can see here that the single execution for our recently uploaded build is `In_Progress` and that the execution ID is `yegz4WN`.
212+
You may notice that the IDs seen above for the run named `FirstRun` match those we saw earlier in Unity Editor's _**Console**_. You can see here that the single execution for our recently uploaded build is `In_Progress` and that the execution ID is `ojE8Z20`.
212213

213-
Unity Simulation utilizes the ability to run simulation Instances in parallel. If you enter a number larger than 1 for the number of Instances in the _**Run in Unity Simulation**_ window, your run will be parallelized, and multiple simulation Instances will simultaneously execute. You can view the status of all simulation Instances using the `usim summarize run-execution <execution-id>` command. This command will tell you how many Instances have succeeded, failed, have not run yet, or are in progress. Make sure to replace `<execution-id>` with the execution ID seen in your run list. In the above example, this ID would be `yegz4WN`.
214+
Unity Simulation utilizes the ability to run simulation Instances in parallel. If you enter a number larger than 1 for the number of Instances in the _**Run in Unity Simulation**_ window, your run will be parallelized, and multiple simulation Instances will simultaneously execute. You can view the status of all simulation Instances using the `usim summarize run-execution <execution-id>` command. This command will tell you how many Instances have succeeded, failed, have not run yet, or are in progress. Make sure to replace `<execution-id>` with the execution ID seen in your run list. In the above example, this ID would be `ojE8Z20`.
214215

215216
* **:green_circle: Action**: Use the `usim summarize run-execution <execution-id>` command to observe the status of your execution nodes:
216217

0 commit comments

Comments
 (0)