Merge branch '0.8.0-preview.1_staging' into ability_to_disable_labeling

Author: Mohsen Kamalzadeh

com.unity.perception/CHANGELOG.md

@@ -9,73 +9,91 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Upgrade Notes
 
-All appearances of the term `KeyPoint` have been renamed to `Keypoint`. Therefore, after upgrading to this version, if you have code that relies on any renamed types or names, make sure to alter your code to reflect the new names.
+### Known Issues
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+## [0.8.0-preview.1] - 2021-03-15
+
+### Upgrade Notes
+
+All appearances of the term `KeyPoint` have been renamed to `Keypoint`. If you have code that relies on any renamed types or names, make sure to alter your code to reflect the new names.
+
+`ScenarioBase`'s `Awake()`, `Start()`, and `Update()` functions are now private. If you previously used these, replace the usages with `OnAwake()`, `OnStart()`, and `OnUpdate()`.
 
 ### Known Issues
 
 ### Added
 
-Added error message when missing Randomizer scripts are detected
+Added error message when missing Randomizer scripts are detected.
 
-Scenario serialization has been updated to include scalar values on randomizers and parameters.
+Scenario serialization has been updated to include scalar values on Randomizers and Parameters.
 
-Added new ScenarioBase virtual lifecycle hooks: OnAwake, OnStart, OnComplete, and OnIdle.
+Added new `ScenarioBase` virtual lifecycle hooks: `OnAwake()`, `OnStart()`, `OnUpdate()`, `OnComplete()`, and `OnIdle()`.
 
-Keypoint occlusion has been added, no keypoint information will be recorded for a labeled asset completely out of the camera's frustum. 
+Keypoint occlusion has been added. No keypoint information will be recorded for a labeled asset completely out of the camera's frustum. 
 
-New keypoint tests have been added to test keypoint state.
+New keypoint tests have been added to test keypoint states.
 
-The color of keypoints and connections are now reported in the annotation definition json file for keypoint templates.
+The color of keypoints and connections are now reported in the annotation definition JSON file for keypoint templates.
 
-The PerceptionScenario abstract class has been added to abstract perception data capture specific functionality from the vanilla scenario lifecycle. 
+The `PerceptionScenario` abstract class has been added to abstract perception data capture specific functionality from the vanilla Scenario lifecycle. 
 
-The newly added LabelManager class now enables custom Labelers to access the list of registered Labeling Components present in the scene.
+The newly added `LabelManager` class now enables custom Labelers to access the list of registered `Labeling` Components present in the Scene.
 
-Improved UI for KeypointTemplate and added useful default colors for keypoint and skeleton definitions.
+Improved UI for `KeypointTemplate` and added useful default colors for keypoint and skeleton definitions.
 
 ### Changed
 
 Renamed all appearances of the term `KeyPoint` within types and names to `Keypoint`.
 
-ScenarioBase's Awake, Start, and Update methods are now private. The newly added virtual lifecycle hooks are to be used as replacements.
+ScenarioBase's `Awake()`, `Start()`, and `Update()` methods are now private. The newly added virtual lifecycle hooks are to be used as replacements.
 
-Improved Run Unity Simulation window UI.
+Improved _Run in Unity Simulation_ window UI.
 
-The Run Unity Simulation window now accepts option scenario JSON configurations to override existing scenario editor settings.
+The _Run in Unity Simulation_ window now accepts an optional Scenario JSON configuration to override existing Scenario editor UI settings.
 
-ScenarioBase's Get and Create randomizer methods have been augmented or replaced with more generic list index style accessors.
+The `GetRandomizer()` and `CreateRandomizer()` methods of `ScenarioBase` have been augmented or replaced with more generic list index style accessors.
 
-The scenario inspector buttons serialize and deserialize have been refactored to open a file explorer generate and import JSON configurations.
+The Scenario inspector buttons for serialization and deserialization have been refactored to open a file explorer so that the user can choose where to save the generated JSON configuration or which file to import a configuration from.
 
-Randomizer tags now use OnEnable and OnDisable to manage lifecycle. This allows the user to toggle them on and off in the editor.
+RandomizerTags now use `OnEnable()` and `OnDisable()` to manage their lifecycle. This allows the user to toggle them on and off in the editor.
 
-The randomizer methods OnCreate(), OnStartRunning(), and OnStopRunning() are now deprecated and have been replaced with OnAwake(), OnEnable() and OnDisable() respectively to better reflect the existing MonoBehaviour lifecycle methods.
+Upgraded `com.unity.simulation.capture` package dependency to integrate new changes that prevent the API updater from looping infinitely when opening the project settings window on new URP projects.
 
-CameraLabeler methods OnBeginRendering() and OnEndRendering() have an added ScriptableRenderContext parameter.
-
-Upgraded com.unity.simulation.capture package dependency to integrate new changes that prevent the API updater from looping infinitely when opening the project settings window on new URP projects.
+`CameraLabeler` methods `OnBeginRendering()` and `OnEndRendering()` now have an added `ScriptableRenderContext` parameter.
 
 ### Deprecated
 
+The Randomizer methods `OnCreate()`, `OnStartRunning()`, and `OnStopRunning()` are now deprecated and have been replaced with `OnAwake()`, `OnEnable()` and `OnDisable()` respectively, so as to better reflect the existing MonoBehaviour lifecycle methods.
+
 ### Removed
 
-Removed the entities package dependency
+Removed the Entities package dependency.
 
 ### Fixed
 
-Fixed a null reference error that appeared when adding options to categorical parameters.
+Fixed a null reference error that appeared when adding options to Categorical Parameters.
 
-Fixed ground truth not properly produced when there are other disabled PerceptionCameras present. Note: this does not yet add support for multiple enabled PerceptionCameras.
+Fixed ground truth not properly being produced when there are other disabled PerceptionCameras present. Note: this does not yet add support for multiple enabled PerceptionCameras.
 
-Fixed exception when rendering inspector for randomizers with private serialized fields
+Fixed an exception when rendering inspector for Randomizers with private serialized fields.
 
-Fixed an issue preventing a user from adding more options to a Categorical Parameter's list of options with the 'Add Folder' button. 'Add Folder' now correctly appends the contents of the new folder on the list.
+Fixed an issue preventing the user from adding more options to a Categorical Parameter's list of options with the _Add Folder_ button. _Add Folder_ now correctly appends the contents of the new folder to the existing list.
 
 Fixed a bug where uniform probabilities were not properly reset upon adding or removing options from a Categorical Parameter's list of options.
 
-Fixed keypoints being reported in wrong locations on the first frame an object is visible. 
+Fixed keypoints being reported in wrong locations on the first frame in which an object is visible. 
 
-Fixed an out of range error if a keypoint template skeleton relies on a joint that is not available.
+Fixed an out of range error that occurred when a keypoint template skeleton relied on a joint that was not available.
 
 Fixed wrong labels on 2d bounding boxes when all labeled objects are deleted in a frame.
 

com.unity.perception/Documentation~/HPTutorial/TUTORIAL.md

@@ -2,7 +2,7 @@
 
 In this tutorial, we will walk through the production of keypoint and pose datasets for computer vision tasks such as human pose estimation and gesture recognition.
 
-We strongly recommend you finish [Phase 1 of the Perception Tutorial](../Tutorial/Phase1.md) before continuing with this one, especially if you do not have prior experience with Unity Editor. This tutorial requires at least version **0.7.0-preview.2** of the Perception package.
+We strongly recommend you finish [Phase 1 of the Perception Tutorial](../Tutorial/Phase1.md) before continuing with this one, especially if you do not have prior experience with Unity Editor. This tutorial requires at least version **0.8.0-preview.1** of the Perception package.
 
 In this tutorial, **":green_circle: Action:"** mark all of the actions needed to progress through the tutorial. If you are in a hurry, just follow the actions!
 
@@ -37,15 +37,15 @@ Your Scenario should now look like this:
 We now need to import the sample files required for this tutorial.  
 
 * **:green_circle: Action**: Open _**Package Manager**_ and select the Perception package, which should already be present in the navigation pane to the left side. 
-* **:green_circle: Action**: From the list of ***Samples*** for the Perception package, click on the ***Import into Project*** button for the sample bundle named _**Human Pose Estimation**_.
+* **:green_circle: Action**: From the list of ***Samples*** for the Perception package, click on the ***Import*** button for the sample bundle named _**Human Pose Labeling and Randomization**_.
 
 Once the sample files are imported, they will be placed inside the `Assets/Samples/Perception` folder in your Unity project, as seen in the image below:
 
 <p align="center">
 <img src="Images/project_folders_samples.png" width="600"/>
 </p>
 
-* **:green_circle: Action**: Select all of the assets inside the `Assets/Samples/Perception/<perception-package-version>/Human Pose Estimation/Models and Animations`.
+* **:green_circle: Action**: Select all of the assets inside the `Assets/Samples/Perception/<perception-package-version>/Human Pose Labeling and Randomization/Models and Animations`.
 * **:green_circle: Action**: In the _**Inspector**_ tab, navigate to the _**Rig**_ section. 
 
 Note how `Animation Type` is set to `Humanoid` for all selected assets. This is a requirement and makes sure all animations included in the sample `.fbx` files are ready to be used on a rigged humanoid model.

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

@@ -79,10 +79,7 @@ The RenderedObjectInfoLabeler records a list of all objects visible in the Camer
 
 ### KeypointLabeler
 
-The keypoint labeler captures keypoints of a labeled gameobject. The typical use of this labeler is capturing human pose
-estimation data. The labeler uses a [keypoint template](#KeypointTemplate) which defines the keypoints to capture for the
-model and the skeletal connections between those keypoints. The positions of the keypoints are recorded in pixel coordinates
-and saved to the captures json file.
+The keypoint labeler captures keypoints of a labeled gameobject. The typical use of this labeler is capturing human pose estimation data. The labeler uses a [keypoint template](#KeypointTemplate) which defines the keypoints to capture for the model and the skeletal connections between those keypoints. The positions of the keypoints are recorded in pixel coordinates. Each keypoint has a state value: 0 - the keypoint either does not exist or is outside of the image's bounds, 1 - the keypoint exists and is inside of the image's bounds but cannot be seen because it is occluded by another object, and 2 - the keypoint exists and is visible.
 
 ```
 keypoints {
@@ -95,7 +92,7 @@ keypoints {
       index:     <int>   -- Index of keypoint in template
       x:         <float> -- X pixel coordinate of keypoint
       y:         <float> -- Y pixel coordinate of keypoint
-      state:     <int>   -- 0: keypoint does not exist, 1 keypoint exists
+      state:     <int>   -- 0: keypoint does not exist, 1: keypoint exists but is not visible, 2: keypoint exists and is visible
     }, ...
   ]
 }

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

@@ -5,7 +5,7 @@
 This page provides brief instructions on installing the Perception package. Head over to the [Perception Tutorial](Tutorial/TUTORIAL.md) for more detailed instructions and steps for building a sample project.
 
 
-1. Install the latest version of 2019.4.x or 2020.1.x Unity Editor from [here](https://unity3d.com/get-unity/download/archive). (Perception has not been tested on Unity versions newer than 2020.1)
+1. Install the latest version of **2020.2.x** Unity Editor from [here](https://unity3d.com/get-unity/download/archive). (The Perception package has not been fully tested on newer Unity versions)
 1. Create a new HDRP or URP project, or open an existing project.
 1. Open `Window` ->  `Package Manager`
 	1. In the Package Manager window find and click the ***+*** button in the upper lefthand corner of the window
@@ -14,6 +14,6 @@ This page provides brief instructions on installing the Perception package. Head
 
 Note that although the Perception package is compatible with both URP and HDRP, Unity Simulation currently only supports URP projects, therefore a URP project is recommended. 
 
-If you want a specific version of the package, append the version to the end of the "git URL". Ex. `com.unity.perception@0.1.0-preview.4`
+If you want a specific version of the package, append the version to the end of the "git URL". Ex. `com.unity.perception@0.8.0-preview.1`
 
 To install from a local clone of the repository, see [installing a local package](https://docs.unity3d.com/Manual/upm-ui-local.html) in the Unity manual.