feat(docs): Improve docstrings across the codebase and docs. (#56)

Author: HochCC

README.md

@@ -37,7 +37,7 @@
 ```sh
 git clone https://github.com/HorizonRobotics/EmbodiedGen.git
 cd EmbodiedGen
-git checkout v0.1.5
+git checkout v0.1.6
 git submodule update --init --recursive --progress
 conda create -n embodiedgen python=3.10.13 -y # recommended to use a new env.
 conda activate embodiedgen

apps/visualize_asset.py

@@ -31,8 +31,8 @@
 
 import gradio as gr
 import pandas as pd
-import yaml
 from app_style import custom_theme, lighting_css
+from embodied_gen.utils.tags import VERSION
 
 try:
     from embodied_gen.utils.gpt_clients import GPT_CLIENT as gpt_client
@@ -48,7 +48,6 @@
 
 
 # --- Configuration & Data Loading ---
-VERSION = "v0.1.5"
 RUNNING_MODE = "local"  # local or hf_remote
 CSV_FILE = "dataset_index.csv"
 

docs/install.md

@@ -7,7 +7,7 @@ hide:
 ```sh
 git clone https://github.com/HorizonRobotics/EmbodiedGen.git
 cd EmbodiedGen
-git checkout v0.1.5
+git checkout v0.1.6
 git submodule update --init --recursive --progress
 conda create -n embodiedgen python=3.10.13 -y # recommended to use a new env.
 conda activate embodiedgen

docs/tutorials/any_simulators.md

@@ -35,7 +35,8 @@ Leverage **EmbodiedGen-generated assets** with *accurate physical collisions* an
 ## 🧱 Example: Conversion to Target Simulator
 
 ```python
-from embodied_gen.data.asset_converter import SimAssetMapper, cvt_embodiedgen_asset_to_anysim
+from embodied_gen.data.asset_converter import cvt_embodiedgen_asset_to_anysim
+from embodied_gen.utils.enum import AssetType, SimAssetMapper
 from typing import Literal
 
 simulator_name: Literal[
@@ -52,6 +53,10 @@ dst_asset_path = cvt_embodiedgen_asset_to_anysim(
         "path1_to_embodiedgen_asset/asset.urdf",
         "path2_to_embodiedgen_asset/asset.urdf",
     ],
+    target_dirs=[
+        "path1_to_target_dir/asset.usd",
+        "path2_to_target_dir/asset.usd",
+    ],
     target_type=SimAssetMapper[simulator_name],
     source_type=AssetType.MESH,
     overwrite=True,