Skip to content

Commit 0671c57

Browse files
Clean up docs and add example projects (#42)
* Updating docs to exclude tests from the scripting docs and adding TableOfContents.md. The table of contents does not properly show up on the index.md. * Adding example project listing to index.md
1 parent 996468e commit 0671c57

File tree

7 files changed

+26
-1
lines changed

7 files changed

+26
-1
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
* [Installation Instructions](SetupSteps.md)
2+
* [Getting Started](GettingStarted.md)
3+
* [Labeling](GroundTruth-Labeling.md)
4+
* [Perception Camera](PerceptionCamera.md)
5+
* [Dataset Capture](DatasetCapture.md)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
apiRules:
2+
- exclude:
3+
uidRegex: Tests$
4+
type: Namespace
5+
- exclude:
6+
uidRegex: Tests
7+
type: Type
201 KB
Loading
251 KB
Loading

com.unity.perception/Documentation~/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@ The Perception package provides a toolkit for generating large-scale datasets fo
99

1010
[Setting up your first perception scene](GettingStarted.md)
1111

12+
## Example projects using Perception
13+
14+
### SynthDet
15+
16+
<img src="images/synthdet.png"/>
17+
18+
[SynthDet](https://github.com/Unity-Technologies/SynthDet) is an end-to-end solution for training a 2d object detection model using synthetic data.
19+
20+
### Unity Simulation Smart Camera Example
21+
<img src="images/smartcamera.png"/>
22+
23+
The [Unity Simulation Smart Camera Example](https://github.com/Unity-Technologies/Unity-Simulation-Smart-Camera-Outdoor) illustrates how Perception could be used in a smart city or autonomous vehicle simulation. Datasets can be generated locally or at scale in [Unity Simulation](https://unity.com/products/unity-simulation).
24+
1225
## Package contents
1326

1427
|Feature|Description

com.unity.perception/Tests/Editor/SimulationManagerEditorTests.cs renamed to com.unity.perception/Tests/Editor/DatasetCaptureEditorTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using NUnit.Framework;
33
using UnityEngine.Perception.GroundTruth;
44

5-
namespace GroundTruth
5+
namespace GroundTruthTests
66
{
77
public class DatasetCaptureEditorTests
88
{

com.unity.perception/Tests/Editor/SimulationManagerEditorTests.cs.meta renamed to com.unity.perception/Tests/Editor/DatasetCaptureEditorTests.cs.meta

File renamed without changes.

0 commit comments

Comments
 (0)