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

Perception Tutorial

Phase 3: Cloud

In this phase of the tutorial, we will learn how to run our Scene on Unity Simulation and analyze the generated dataset using Dataset Insights. Unity Simulation will allow us to generate a much larger dataset than what is typically plausible on a workstation computer.

Steps included in this phase of the tutorial:

• Step 1: Setup Unity Account, Unity Simulation, and Cloud Project
• Step 2: Run Project on Unity Simulation
• Step 3: Keep Track of Your Runs Using the Unity Simulation Command-Line Interface

Step 1: Setup Unity Account, Unity Simulation, and Cloud Project

In order to use Unity Simulation, you need to first create a Unity account or login with your existing one. Once logged in, you will also need to sign-up for Unity Simulation.

• 🟢 Action Click on the Cloud button at the top-right corner of Unity Editor to open the Services tab.

• 🟢 Action Click the General settings.

This will open the Services tab of the Project Settings window. If you have not logged in yet, you will see a message noting that you are signed out:

• 🟢 Action: Click Sign in... and follow the steps in the window that opens to sign in or create a Unity account.
• 🟢 Action: Sign up for a free trial of Unity Simulation here.

Unity Simulation is a cloud-based service that makes it possible for you to run hundreds of instances of Unity builds in order to generate massive amounts of data. The Unity Simulation service is billed on a per-usage basis, and the free trial offers up to $100 of free credit per month. In order to access the free trial, you will need to provide credit card information. This information will be used to charge your account if you exceed the $100 monthly credit. A list of hourly and daily rates for various computational resources is available in the page where you first register for Unity Simulation.

Once you have registered for a free trial, you will be taken to your Unity Simulation dashboard, where you will be able to observe your usage and billing information.

It is now time to connect your local Unity project to a cloud project.

• 🟢 Action: Return to Unity Editor. Click Select Organization and choose the only available option (which typically has the same name as your Unity username).

If you have used Unity before, you might have set up multiple organizations for your account. In that case, choose whichever you would like to associate with this project.

• 🟢 Action: Click Create Project ID to create a new cloud project and connect your local project to it.

Step 2: Run Project on Unity Simulation

The process of running a project on Unity Simulation involves building it for Linux and then uploading this build, along with a set of parameters, to Unity Simulation. The Perception package simplifies this process by including a dedicated Run in Unity Simulation window that accepts a small number of required parameters and handles everything else automatically.

• 🟢 Action: From the Inspector view of Perception Camera, disable real-time visualizations.

In order to make sure our builds are compatible with Unity Simulation, we need to set our project's scripting backend to Mono rather than IL2CPP (if not already set). We will also need to switch to Windowed mode.

• 🟢 Action: From the top menu bar, open Edit -> Project Settings.
• 🟢 Action: In the window that opens, navigate to the Player tab, find the Scripting Backend setting (under Other Settings), and change it to Mono:

• 🟢 Action: Change Fullscreen Mode to Windowed and set a width and height of 800 by 600.

• 🟢 Action: Close Project Settings.
• 🟢 Action: From the top menu bar, open Window -> Run in Unity Simulation.

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.

• 🟢 Action: Name your run FirstRun, set the number of Iterations to 1000, and Instances to 20.
• 🟢 Action: If you'd like to use a new random seed for this run of your Scenario, click Randomize to generate a new seed.
• 🟢 Action: Click Build and Run.

ℹ️ 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.

Your project will now be built and then uploaded to Unity Simulation and run. This may take a few minutes to complete, during which the editor may become frozen; this is normal behaviour.

• 🟢 Action: Once the operation is complete, you can find the Execution ID of this Unity Simulation run in the Console tab and the Run in Unity Simulation Window:

Step 3: Keep Track of Your Runs Using the Unity Simulation Command-Line Interface

To keep track of the progress of your Unity Simulation run, you will need to use Unity Simulation's command-line interface (CLI). Detailed instructions for this CLI are provided here. For the purposes of this tutorial, we will only go through the most essential commands, which will help us know when our Unity Simulation run is complete and where to find the produced dataset.

• 🟢 Action: Download the latest version of unity_simulation_bundle.zip from here.

ℹ️ If you are using a MacOS computer, we recommend using the curl command from the Terminal to download the file, in order to avoid issues caused by the MacOS Gatekeeper when using the CLI. You can use these commands:

curl -Lo ~/Downloads/unity_simulation_bundle.zip <URL-unity_simulation_bundle.zip>
unzip ~/Downloads/unity_simulation_bundle.zip -d ~/Downloads/unity_simulation_bundle

The <URL-unity_simulation_bundle.zip> address can be found at the same page linked above.

• 🟢 Action: Extract the zip archive you downloaded.
• 🟢 Action: Open a command-line interface (Terminal on MacOS, cmd on Windows, etc.) and navigate to the extracted folder.

If you downloaded the zip archive in the default location in your downloads folder, you can use these commands to navigate to it from the command-line:

MacOS: cd ~/Downloads/unity_simulation_bundle

Windows: cd C:\Users\UserName\Downloads\unity_simulation_bundle

You will now be using the usim executable to interact with Unity Simulation through commands.

• 🟢 Action To see a list of available commands, simply run usim once:

MacOS: USimCLI/mac/usim

Windows: USimCLI\windows\usim

The first step is to login.

• 🟢 Action: Login to Unity Simulation using the usim login auth command.

MacOS: USimCLI/mac/usim login auth

Windows: USimCLI\windows\usim login auth

This command will ask you to press Enter to open a browser for you to login to your Unity account:

Press [ENTER] to open your browser to ...

• 🟢 Action: Press Enter to open a browser window for logging in.

Once you have logged you will see this page:

⚠️ On MacOS, you might get errors related to permissions. If that is the case, modify the permissions on the ~/.usim folder and its contents to give your user full read and write permission.

ℹ️ From this point on we will only include MacOS formatted commands in the tutorial, but all the usim commands we use will work in all supported operating systems.**

• 🟢 Action: Return to your command-line interface. Get a list of cloud projects associated with your Unity account using the usim get projects command:

MacOS: USimCLI/mac/usim get projects

Example output:

 name                  id                                       creation time             
--------------------- ---------------------------------------- --------------------------- 
 Perception Tutorial   38baa0d0-a2cd-4ee1-801b-39ca3fc5cbc6 *   2020-09-30T00:33:41+00:00 
 SynthDet              9ec23417-73cd-becd-9dd6-556183946153     2020-08-12T19:46:20+00:00  

In case you have more than one cloud project, you will need to "activate" the one corresponding with your Perception Tutorial project. If there is only one project, it is already activated, and you will not need to execute the command below (note: replace <project-id> with the id of your desired project).

• 🟢 Action: Activate the relevant project:

MacOS: USimCLI/mac/usim activate project <project-id>

When asked if you are sure you want to change the active project, enter "y" and press Enter.

Now that we have made sure the correct project is active, we can get a list of all the current and past runs for the project.

• 🟢 Action: Use the usim get runs command to obtain a list of current and past runs:

MacOS: USimCLI/mac/usim get runs

An example output with 3 runs would look like this:

Active Project ID: 38baa0d0-a2cd-4ee1-801b-39ca3fc5cbc6
name        id        creation time         executions                                    
----------- --------- --------------------- -----------------------------------------------
 FirstRun    1tLbZxL   2020-10-01 23:17:50    id        status        created_at           
                                             --------- ------------- --------------------- 
                                              ojE8Z20   In_Progress   2020-10-01 23:17:54  
 Run2        klvfxgT   2020-10-01 21:46:39    id        status        created_at           
                                             --------- ------------- --------------------- 
                                              kML3i50   In_Progress   2020-10-01 21:46:42  
 Test        4g9xmW7   2020-10-01 02:27:06    id        status      created_at             
                                             --------- ----------- ---------------------   
                                              xBv3arj   Completed   2020-10-01 02:27:11    

As seen above, each run has a name, an ID, a creation time, and a list of executions. Note that each "run" can have more than one "execution", as you can manually execute runs again using the CLI.

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

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.

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.

• 🟢 Action: Use the usim summarize run-execution <execution-id> command to observe the status of your execution nodes:

MacOS: USimCLI/mac/usim summarize run-execution <execution-id>

Here is an example output of this command, indicating that there are 20 nodes, and that they are all still in progress:

 state         count 
------------- -------
 Successes     0     
 In Progress   20     
 Failures      0     
 Not Run       0    

At this point, we will need to wait until the execution is complete. Check your run with the above command periodically until you see a 20 for Successes and 0 for In Progress. Given the relatively small size of our Scenario (1,000 Iterations), this should take less than 5 minutes.

• 🟢 Action: Use the usim summarize run-execution <execution-id> command periodically to check the progress of your run.
• 🟢 Action: When execution is complete, use the usim download manifest <execution-id> command to download the execution's manifest:

MacOS: USimCLI/mac/usim download manifest <execution-id>

The manifest is a .csv formatted file and will be downloaded to the same location from which you execute the above command, which is the unity_simulation_bundle folder. This file does not include actual data, rather, it includes links to the generated data, including the JSON files, the logs, the images, and so on.

• 🟢 Action: Open the manifest file to check it. Make sure there are links to various types of output and check a few of the links to see if they work.

Once the run execution is complete, you can use Unity's Datasets Insights framework to download your dataset and analyze it. This is covered in the Unity Simulation section of the Dataset Insights guide.

The next step in this workflow, which is out of the scope of this tutorial, is to train an object-detection model using our synthetic dataset. It is important to note that the 1000 large dataset we generated here is probably not sufficiently large for training most models. We chose this number here so that the Unity Simulation run would finish quickly, allowing us to move on to learning how to analyze the statistics of the dataset. In order to generate data for training, we recommend a minimum dataset size of around 50,000 captures with a large degree of randomization.

This concludes the Perception Tutorial. In case of any issues or questions, please feel free to open a GitHub issue on the com.unity.perception repository so that the Unity Computer Vision team can get back to you as soon as possible.