This commit is contained in:
You-Cyuan Jhang 2020-08-11 12:20:05 -07:00
Родитель a7ccd52d41
Коммит c8efc7d25f
2 изменённых файлов: 19 добавлений и 19 удалений

Просмотреть файл

@ -1,6 +1,6 @@
# Getting Started with SynthDet
The goal of the workflow steps is to provide you with everything that you need to get started using the SynthDet project to create a synthetic dataset of grocery products and explore statistics on the dataset.
The goal of the workflow steps is to provide you with everything that you need to get started using the SynthDet project to create a synthetic dataset of grocery products and explore statistics on the dataset.
## Workflow (Step-by-step)
@ -9,16 +9,16 @@ The goal of the workflow steps is to provide you with everything that you need t
1. Start the Unity Hub
2. Click Add... and select the (repo root)/SynthDet folder
3. Click the project to open it
4. In the project view in the editor find and locate the Scenes folder and open the MainScene
4. In the project view in the editor find and locate the Scenes folder and open the MainScene
<img src="images/MainScene.PNG" align="middle"/>
### Step 2: Generating data locally
### Step 2: Generating data locally
1. With MainScene open press play. You should see randomized images being quickly generated in the game view.
<img src="images/PlayBttn.png" align="middle"/>
2. The MainScene will continue for ~1 minute before exiting. Allow the scene to run until play mode is exited.
3. To view the dataset, navigate to the following location depending on your OS:
- OSX: `~/Library/Application Support/UnityTechnologies/SynthDet`
- OSX: `~/Library/Application\ Support/UnityTechnologies/SynthDet`
- Linux: `$XDG_CONFIG_HOME/unity3d/UnityTechnologies/SynthDet`
- Windows: `%userprofile%\AppData\LocalLow\UnityTechnologies\SynthDet`
@ -36,10 +36,10 @@ Replace `<Synthetic Data File Path>` with the path the local datasets (listed ab
> See [Docker Troubleshooting](DockerTroubleshooting.md) if you hit issues with Docker on Windows.
2. Open jupyter by navigating to http://localhost:8888 in a web browser.
<img src="images/jupyterFolder.PNG" align="middle"/>
3. Navigate to `datasetinsights/notebooks` in jupyter
3. Navigate to `datasetinsights/notebooks` in jupyter
4. Open the SynthDet_Statistics.ipynb notebook
<img src="images/theaNotebook.PNG" align="middle"/>

Просмотреть файл

@ -10,10 +10,10 @@ If you would like to use Unity Simulation please sign up for the [Unity Simulati
See the "Additional requirements for running in Unity Simulation" section in [Prerequisites](Prerequisites.md)
### Step 2: Open the SynthDet Sample project
Please follow the Steps 1 & 2 in the [Getting Started with SynthDet](GettingStartedSynthDet.md)
Please follow the Steps 1 & 2 in the [Getting Started with SynthDet](GettingStartedSynthDet.md)
### Step 3: Connect to Cloud Services
The project will need to be connected to cloud services and a org id in order to access Unity Simulations in the cloud services
### Step 3: Connect to Cloud Services
The project will need to be connected to cloud services and a org id in order to access Unity Simulations in the cloud services
1. To run the app on Unity Simulation, connect to cloud services and create a new Unity Project ID using the following steps:
1. In the top right corner of the editor click the cloud button
@ -22,7 +22,7 @@ The project will need to be connected to cloud services and a org id in order to
<img src="images/OpenCloudServices.png" align="middle"/>
2. Make sure you are logged into your Unity account as well
3. Create a new Unity Project ID
3. Create a new Unity Project ID
<img src="images/CreateNewUnityProjectID.png" align="middle"/>
@ -34,7 +34,7 @@ The project will need to be connected to cloud services and a org id in order to
### Step 4: Run SynthDet in Unity Simulation
1. Start a run in Unity Simulation using the Run in USim window, once the run is executed it will take time ~ 10 mins for the run to complete
1. Start a run in Unity Simulation using the Run in USim window, once the run is executed it will take time ~ 10 mins for the run to complete
1. Under Window -> Run in USim…
2. Fill out the Run Name with an example name i.e. SynthDetTestRun
3. If you are curious about the parameters in this window check out the [Unity Simulation information guide](UnitySimulationHelpInformation.md)
@ -47,21 +47,21 @@ The project will need to be connected to cloud services and a org id in order to
<img src="images/NoteExecutionID.PNG" align="middle"/>
If you run into issues, check [Unity Simulation Help and Information](UnitySimulationHelpInformation.md)
If you run into issues, check [Unity Simulation Help and Information](UnitySimulationHelpInformation.md)
### Step 5: Monitor status using Unity Simulation CLI
Once the Unity Simulation run has been executed, the run needs to be verified that it has completed.
1. Check the current summary of the execution run in Unity Simulation since we need the run to be completed
1. Open a command line interface and navigate to the USim CLI for your platform
1. Check the current summary of the execution run in Unity Simulation since we need the run to be completed
1. Open a command line interface and navigate to the USim CLI for your platform
2. Run the command `usim login auth`, this will authorize your account and log in
3. In the command window run this command `summarize run-execution <execution id>`
1. If you receive an error about the active project please go to [Unity Simulation Help](UnitySimulationHelpInformation.md)
2. The command may need to be ran few times because you dont want to continue until the run reports that it has completed
2. The command may need to be ran few times because you dont want to continue until the run reports that it has completed
<img src="images/usimSumExecution.PNG" align="middle"/>
2. (Optional) Download the manifest and check the generated data
2. (Optional) Download the manifest and check the generated data
1. Run the cmd `usim download manifest <execution id>`
2. This will download a csv file that will contain links to the generated data
3. Verify some of the data looks good before continuing
@ -70,17 +70,17 @@ Once the Unity Simulation run has been executed, the run needs to be verified th
1. Run the `datasetinsights` docker image from DockerHub using the following command:
```docker run -p 8888:8888 -v $HOME/data:/data -t unitytechnologies/datasetinsights:0.0.1```
```docker run -p 8888:8888 -v $HOME/data:/data -t unitytechnologies/datasetinsights:0.1.2```
Replace `$HOME/data` with the path where you want the dataset to be downloaded.
> See [Docker Troubleshooting](DockerTroubleshooting.md) if you hit issues with Docker on Windows.
2. Open jupyter by navigating to http://localhost:8888 in a web browser.
<img src="images/jupyterFolder.PNG" align="middle"/>
3. Navigate to `datasetinsights/notebooks` in jupyter
3. Navigate to `datasetinsights/notebooks` in jupyter
4. Open the SynthDet_Statistics.ipynb notebook
<img src="images/theaNotebook.PNG" align="middle"/>