From 980a29c7a25f573feaef37546180908791640756 Mon Sep 17 00:00:00 2001 From: Sanyam Jain Date: Fri, 20 Oct 2023 14:37:26 +0530 Subject: [PATCH 1/2] Update building_blocks.md --- docs/getting_started/building_blocks.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/getting_started/building_blocks.md b/docs/getting_started/building_blocks.md index c3fce4b21..0b4bf5674 100644 --- a/docs/getting_started/building_blocks.md +++ b/docs/getting_started/building_blocks.md @@ -11,7 +11,7 @@ icon: octicons/package-16 ??? question annotate "Why macros?" - Macros enforce global behavior that is consistent within an individual python process but can differ between processes. This is useful because globally enabling all of **`OmniGibson`**'s features can cause unecessary slowdowns, and so configuring the macros for your specific use case can optimize performance. + Macros enforce global behavior that is consistent within an individual python process but can differ between processes. This is useful because globally enabling all of **`OmniGibson`**'s features can cause unnecessary slowdowns, and so configuring the macros for your specific use case can optimize performance. For example, Omniverse provides a so-called `flatcache` feature which provides significant performance boosts, but cannot be used when fluids or soft bodies are present. So, we ideally should always have `gm.USE_FLATCACHE=True` unless we have fluids or soft bodies in our environment. @@ -219,7 +219,7 @@ This demo loads the Rs_int scene and highlights windows on/off repeatedly. python -m omnigibson.examples.objects.draw_bounding_box ``` -This demo loads a door object and banana object, and partially obscures the banana with the door. It generates both "loose" and "tight" bounding boxes (where the latter respects occlusions) for both objects, and dumps them to an image on disk. +This demo loads a door object and a banana object, and partially obscures the banana with the door. It generates both "loose" and "tight" bounding boxes (where the latter respects occlusions) for both objects, and dumps them to an image on disk. ??? code "draw_bounding_box.py" @@ -387,7 +387,7 @@ This demo loads in a carpet on top of a table. The demo allows you to manipulate python -m omnigibson.examples.object_states.particle_applier_remover_demo ``` -This demo loads in a washtowel and table and lets you choose the ability configuration to enable the washtowel with. The washtowel will then proceed to either remove and generate particles dynamically on the table while moving. +This demo loads in a washtowel and table and lets you choose the ability configuration to enable the washtowel with. The washtowel will then proceed to either remove or generate particles dynamically on the table while moving. ??? code "particle_applier_remover_demo.py" @@ -407,7 +407,7 @@ python -m omnigibson.examples.object_states.particle_source_sink_demo This demo loads in a sink, which is enabled with both the ParticleSource and ParticleSink states. The sink's particle source is located at the faucet spout and spawns a continuous stream of water particles, which is then destroyed ("sunk") by the sink's particle sink located at the drain. -??? note "Difference bewteen `ParticleApplier/Removers` and `ParticleSource/Sinks`" +??? note "Difference between `ParticleApplier/Removers` and `ParticleSource/Sinks`" The key difference between `ParticleApplier/Removers` and `ParticleSource/Sinks` is that `Applier/Removers` requires contact (if using `ParticleProjectionMethod.ADJACENCY`) or overlap (if using `ParticleProjectionMethod.PROJECTION`) in order to spawn / remove particles, and generally only spawn From 524d02dae3e1d881e3bd84f3131d27c68f77dad0 Mon Sep 17 00:00:00 2001 From: Sanyam Jain Date: Fri, 20 Oct 2023 22:19:14 +0530 Subject: [PATCH 2/2] Update building_blocks.md --- docs/getting_started/building_blocks.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting_started/building_blocks.md b/docs/getting_started/building_blocks.md index 0b4bf5674..d66bcfa0b 100644 --- a/docs/getting_started/building_blocks.md +++ b/docs/getting_started/building_blocks.md @@ -11,7 +11,7 @@ icon: octicons/package-16 ??? question annotate "Why macros?" - Macros enforce global behavior that is consistent within an individual python process but can differ between processes. This is useful because globally enabling all of **`OmniGibson`**'s features can cause unnecessary slowdowns, and so configuring the macros for your specific use case can optimize performance. + Macros enforce global behavior that is consistent within an individual python process but can differ between processes. This is useful because globally enabling all of **`OmniGibson`**'s features can cause unecessary slowdowns, and so configuring the macros for your specific use case can optimize performance. For example, Omniverse provides a so-called `flatcache` feature which provides significant performance boosts, but cannot be used when fluids or soft bodies are present. So, we ideally should always have `gm.USE_FLATCACHE=True` unless we have fluids or soft bodies in our environment. @@ -407,7 +407,7 @@ python -m omnigibson.examples.object_states.particle_source_sink_demo This demo loads in a sink, which is enabled with both the ParticleSource and ParticleSink states. The sink's particle source is located at the faucet spout and spawns a continuous stream of water particles, which is then destroyed ("sunk") by the sink's particle sink located at the drain. -??? note "Difference between `ParticleApplier/Removers` and `ParticleSource/Sinks`" +??? note "Difference bewteen `ParticleApplier/Removers` and `ParticleSource/Sinks`" The key difference between `ParticleApplier/Removers` and `ParticleSource/Sinks` is that `Applier/Removers` requires contact (if using `ParticleProjectionMethod.ADJACENCY`) or overlap (if using `ParticleProjectionMethod.PROJECTION`) in order to spawn / remove particles, and generally only spawn