docstrings

objaverse_xl/objaverse_v1.py

@@ -333,11 +333,49 @@ class Sketchfab(ObjaverseSource):
             objects (pd.DataFrame): Objects to download. Must have columns for
                 the object "fileIdentifier" and "sha256". Use the `load_annotations`
                 function to get the metadata.
-            processes (int, optional): The number of processes to use to download
-                the objects. Defaults to 1.
             download_dir (Optional[str], optional): The base directory to download the
                 object to. Supports all file systems supported by fsspec. If None, the
                 objects will be removed after downloading. Defaults to "~/.objaverse".
+            processes (int, optional): The number of processes to use to download
+                the objects. Defaults to 1.
+            handle_found_object (Optional[Callable], optional): Called when an object is
+                successfully found and downloaded. Here, the object has the same sha256
+                as the one that was downloaded with Objaverse-XL. If None, the object
+                will be downloaded, but nothing will be done with it. Args for the
+                function include:
+                - local_path (str): Local path to the downloaded 3D object.
+                - file_identifier (str): File identifier of the 3D object.
+                - sha256 (str): SHA256 of the contents of the 3D object.
+                - metadata (Dict[Hashable, Any]): Metadata about the 3D object,
+                    including the GitHub organization and repo names.
+                Return is not used. Defaults to None.
+            handle_modified_object (Optional[Callable], optional): Called when a
+                modified object is found and downloaded. Here, the object is
+                successfully downloaded, but it has a different sha256 than the one that
+                was downloaded with Objaverse-XL. This is not expected to happen very
+                often, because the same commit hash is used for each repo. If None, the
+                object will be downloaded, but nothing will be done with it. Args for
+                the function include:
+                - local_path (str): Local path to the downloaded 3D object.
+                - file_identifier (str): File identifier of the 3D object.
+                - new_sha256 (str): SHA256 of the contents of the newly downloaded 3D
+                    object.
+                - old_sha256 (str): Expected SHA256 of the contents of the 3D object as
+                    it was when it was downloaded with Objaverse-XL.
+                - metadata (Dict[Hashable, Any]): Metadata about the 3D object, which is
+                    particular to the souce.
+                Return is not used. Defaults to None.
+            handle_missing_object (Optional[Callable], optional): Called when an object
+                that is in Objaverse-XL is not found. Here, it is likely that the
+                repository was deleted or renamed. If None, nothing will be done with
+                the missing object.
+                Args for the function include:
+                - file_identifier (str): File identifier of the 3D object.
+                - sha256 (str): SHA256 of the contents of the original 3D object.
+                - metadata (Dict[Hashable, Any]): Metadata about the 3D object, which is
+                    particular to the source.
+                Return is not used. Defaults to None.
+
 
         Returns:
             A dictionary mapping the object fileIdentifier to the local path of where