load_annotations -> get_annotations

objaverse_xl/abstract.py

@@ -6,7 +6,7 @@ from typing import Optional, Callable
 
 class ObjaverseSource(ABC):
     @abstractmethod
-    def load_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
+    def get_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
         """Loads the 3D object metadata as a Pandas DataFrame.
 
         Args:
@@ -35,7 +35,7 @@ class ObjaverseSource(ABC):
 
         Args:
             objects (pd.DataFrame): Objects to download. Must have columns for
-                the object "fileIdentifier" and "sha256". Use the `load_annotations`
+                the object "fileIdentifier" and "sha256". Use the `get_annotations`
                 function to get the metadata.
             processes (Optional[int], optional): Number of processes to use for
                 downloading.  If None, will use the number of CPUs on the machine.

objaverse_xl/github.py

@@ -37,7 +37,7 @@ FILE_EXTENSIONS = [
 class GitHubDownloader(ObjaverseSource):
     """Script to download objects from GitHub."""
 
-    def load_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
+    def get_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
         """Loads the GitHub 3D object metadata as a Pandas DataFrame.
 
         Args:
@@ -404,7 +404,7 @@ class GitHubDownloader(ObjaverseSource):
 
         Args:
             objects (pd.DataFrame): GitHub objects to download. Must have columns for
-                the object "fileIdentifier" and "sha256". Use the load_github_metadata
+                the object "fileIdentifier" and "sha256". Use the `get_annotations`
                 function to get the metadata.
             download_dir (str, optional): Directory to download the GitHub objects to.
                 Supports all file systems supported by fsspec. Defaults to

objaverse_xl/objaverse_v1.py

@@ -21,7 +21,7 @@ from tqdm import tqdm
 class SketchfabDownloader(ObjaverseSource):
     """A class for downloading and processing Objaverse 1.0."""
 
-    def load_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
+    def get_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
         """Load the annotations from the given directory.
 
         Args:
@@ -333,7 +333,7 @@ class SketchfabDownloader(ObjaverseSource):
 
         Args:
             objects (pd.DataFrame): Objects to download. Must have columns for
-                the object "fileIdentifier" and "sha256". Use the `load_annotations`
+                the object "fileIdentifier" and "sha256". Use the `get_annotations`
                 function to get the metadata.
             download_dir (Optional[str], optional): The base directory to download the
                 object to. Supports all file systems supported by fsspec. If None, the

objaverse_xl/smithsonian.py

@@ -17,7 +17,9 @@ from objaverse_xl.abstract import ObjaverseSource
 
 
 class SmithsonianDownloader(ObjaverseSource):
-    def load_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
+    """Script to download objects from the Smithsonian Institute."""
+
+    def get_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
         """Loads the Smithsonian Object Metadata dataset as a Pandas DataFrame.
 
         Args:
@@ -188,7 +190,7 @@ class SmithsonianDownloader(ObjaverseSource):
 
         Args:
             objects (pd.DataFrmae): Objects to download. Must have columns for
-                the object "fileIdentifier" and "sha256". Use the `load_annotations`
+                the object "fileIdentifier" and "sha256". Use the `get_annotations`
                 function to get the metadata.
             download_dir (Optional[str], optional): Directory to download the
                 Smithsonian Objects to. Supports all file systems supported by fsspec.

objaverse_xl/thingiverse.py

@@ -19,7 +19,7 @@ from tqdm import tqdm
 class ThingiverseDownloader(ObjaverseSource):
     """Script to download objects from Thingiverse."""
 
-    def load_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
+    def get_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
         """Load the annotations from the given directory.
 
         Args:
@@ -247,8 +247,9 @@ class ThingiverseDownloader(ObjaverseSource):
         """Download the objects from the given list of things and files.
 
         Args:
-            file_ids (Optional[List[str]]): The list of file IDs to download. If None,
-                downloads all files. Defaults to None.
+            objects (pd.DataFrame): Thingiverse objects to download. Must have columns
+                for the object "fileIdentifier" and "sha256". Use the `get_annotations`
+                function to get the metadata.
             processes (int, optional): The number of processes to use. If None, maps to
                 use all available CPUs using multiprocessing.cpu_count(). Defaults to None.
             download_dir (str, optional): The directory to save the files to. Supports all