Update README.md

README.md

@@ -47,7 +47,7 @@ dataset_summary: >
 
   # Note: other available arguments include 'max_samples', etc
 
-  dataset = load_from_hub("harpreetsahota/crops3d")
+  dataset = load_from_hub("Voxel51/crops3d")
 
 
   # Launch the App
@@ -84,34 +84,70 @@ from huggingface_hub import snapshot_download
 
 
 # Download the dataset snapshot to the current working directory
-snapshot_download(repo_id="harpreetsahota/crops3d", local_dir=".", repo_type="dataset")
+
+snapshot_download(repo_id="Voxel51/crops3d", local_dir=".", repo_type="dataset")
 
 import fiftyone as fo
 
+import fiftyone as fo
+import os
+import json
+
+# Load dataset from current directory using FiftyOne's native format
 dataset = fo.Dataset.from_dir(
-    dataset_dir=".",
-    dataset_type=fo.types.FiftyOneDataset,
-    name="crops3d"
+    dataset_dir=".",  # Current directory contains the dataset files
+    dataset_type=fo.types.FiftyOneDataset,  # Specify FiftyOne dataset format
+    name="crops3d"  # Assign a name to the dataset for identification
 )
 
 def update_dataset_ply_paths(dataset):
+    """
+    Update PLY file paths in FiftyOne 3D dataset to use absolute paths.
+    
+    This function iterates through all samples in a FiftyOne dataset and modifies
+    any PLY mesh file paths found in the JSON metadata to be absolute paths
+    relative to the sample's directory location.
+    
+    Args:
+        dataset (fiftyone.Dataset): A FiftyOne dataset containing 3D samples
+                                   with JSON metadata files that may reference
+                                   PLY mesh files with relative paths.
+    
+    Returns:
+        None: The function modifies the JSON files in-place on disk.
+    
+    Note:
+        - This function assumes each sample's filepath points to a JSON file
+        - The JSON structure should contain a 'children' array with objects
+        - PLY mesh objects are identified by '_type': 'PlyMesh'
+        - Only objects with a 'plyPath' field will be updated
+    """
+    # Iterate through each sample in the dataset
     for sample in dataset:
+        # Get the file path of the current sample (JSON metadata file)
         fo3d_filepath = sample.filepath
+        
+        # Extract the directory containing the sample file
         fo3d_directory = os.path.dirname(fo3d_filepath)
         
+        # Read and parse the JSON metadata file
         with open(fo3d_filepath, 'r') as f:
             fo3d_data = json.load(f)
         
+        # Process each child object in the JSON structure
         for child in fo3d_data.get('children', []):
+            # Check if this child is a PLY mesh object with a path reference
             if child.get('_type') == 'PlyMesh' and 'plyPath' in child:
+                # Convert relative PLY path to absolute path
+                # by joining it with the sample's directory
                 child['plyPath'] = os.path.join(fo3d_directory, child['plyPath'])
         
+        # Write the updated JSON data back to the file
         with open(fo3d_filepath, 'w') as f:
-            json.dump(fo3d_data, f, indent=2)
+            json.dump(fo3d_data, f, indent=2)  # Pretty-print with 2-space indentation
 
-# Usage:
+# Execute the path update function on the loaded dataset
 update_dataset_ply_paths(dataset)
-
 ```
 
 # Dataset Details
@@ -120,9 +156,9 @@ update_dataset_ply_paths(dataset)
 
 **Curated by:** Jianzhong Zhu, Ruifang Zhai, He Ren, Kai Xie, Aobo Du, Xinwei He, Chenxi Cui, Yinghua Wang, Junli Ye, Jiashi Wang, Xue Jiang, Yulong Wang, Chenglong Huang, Wanneng Yang (Huazhong Agricultural University, China)
 
-**Funded by [optional]:** National Natural Science Foundation of China, National Key Research and Development Program of China
+**Funded by:** National Natural Science Foundation of China, National Key Research and Development Program of China
 
-**Shared by [optional]:** Huazhong Agricultural University, National Key Laboratory of Crop Genetic Improvement
+**Shared by:** Huazhong Agricultural University, National Key Laboratory of Crop Genetic Improvement
 
 **Language(s) (NLP):** Not applicable (3D point cloud dataset)