File size: 4,884 Bytes
aae8281 f0928f6 aae8281 8f7b31b aae8281 8f7b31b aae8281 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
from abc import ABC, abstractmethod
import pandas as pd
from typing import Optional, Callable
class ObjaverseSource(ABC):
@abstractmethod
def load_annotations(self, download_dir: str = "~/.objaverse") -> pd.DataFrame:
"""Loads the 3D object metadata as a Pandas DataFrame.
Args:
download_dir (str, optional): Directory to download the parquet metadata
file. Supports all file systems supported by fsspec. Defaults to
"~/.objaverse".
Returns:
pd.DataFrame: Metadata of the 3D objects as a Pandas DataFrame with columns
for the object "fileIdentifier", "license", "source", "fileType",
"sha256", and "metadata".
"""
@abstractmethod
def download_objects(
self,
objects: pd.DataFrame,
download_dir: str = "~/.objaverse",
processes: Optional[int] = None,
handle_found_object: Optional[Callable] = None,
handle_modified_object: Optional[Callable] = None,
handle_missing_object: Optional[Callable] = None,
**kwargs
) -> None:
"""Downloads all objects from the source.
Args:
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 (Optional[int], optional): Number of processes to use for
downloading. If None, will use the number of CPUs on the machine.
Defaults to None.
download_dir (str, optional): Directory to download the objects to.
Supports all file systems supported by fsspec. Defaults to
"~/.objaverse".
save_repo_format (Optional[Literal["zip", "tar", "tar.gz", "files"]],
optional): Format to save the repository. If None, the repository will
not be saved. If "files" is specified, each file will be saved
individually. Otherwise, the repository can be saved as a "zip", "tar",
or "tar.gz" file. Defaults to None.
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:
None
"""
pass
|