naming updates

objaverse_xl/github.py

@@ -180,10 +180,9 @@ def _process_repo(
             if handle_missing_object is not None:
                 for github_url, sha256 in expected_objects.items():
                     handle_missing_object(
-                        github_url=github_url,
+                        file_identifier=github_url,
                         sha256=sha256,
-                        repo=repo,
-                        organization=org,
+                        metadata=dict(github_organization=org, github_repo=repo),
                     )
             return []
 
@@ -232,7 +231,7 @@ def _process_repo(
 
         # get the sha256 for each file
         file_hashes = []
-        for file in files_with_3d_extension:
+        for file in tqdm(files_with_3d_extension, desc="Handling 3D object files"):
             file_hash = get_file_hash(file)
             # remove the temp_dir from the file path
             github_url = file.replace(
@@ -246,28 +245,26 @@ def _process_repo(
                 if expected_objects[github_url] == file_hash:
                     if handle_found_object is not None:
                         handle_found_object(
-                            file=file,
-                            github_url=github_url,
+                            local_path=file,
+                            file_identifier=github_url,
                             sha256=file_hash,
-                            repo=repo,
-                            organization=org,
+                            metadata=dict(github_organization=org, github_repo=repo),
                         )
                 else:
                     if handle_modified_object is not None:
                         handle_modified_object(
-                            file=file,
-                            github_url=github_url,
-                            sha256=file_hash,
-                            repo=repo,
-                            organization=org,
+                            local_path=file,
+                            file_identifier=github_url,
+                            new_sha256=file_hash,
+                            old_sha256=expected_objects[github_url],
+                            metadata=dict(github_organization=org, github_repo=repo),
                         )
             elif handle_new_object is not None:
                 handle_new_object(
-                    file=file,
-                    github_url=github_url,
+                    local_path=file,
+                    file_identifier=github_url,
                     sha256=file_hash,
-                    repo=repo,
-                    organization=org,
+                    metadata=dict(github_organization=org, github_repo=repo),
                 )
 
         # save the file hashes to a json file
@@ -319,10 +316,9 @@ def _process_repo(
         for github_url, sha256 in expected_objects.items():
             if github_url not in obtained_urls:
                 handle_missing_object(
-                    github_url=github_url,
+                    file_identifier=github_url,
                     sha256=sha256,
-                    repo=repo,
-                    organization=org,
+                    metadata=dict(github_organization=org, github_repo=repo),
                 )
 
     return file_hashes
@@ -434,24 +430,22 @@ def download_github_objects(
             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:
-            - file (str): Local path to the downloaded 3D object.
-            - github_url (str): GitHub URL of the 3D object.
+            - local_path (str): Local path to the downloaded 3D object.
+            - file_identifier (str): GitHub URL of the 3D object.
             - sha256 (str): SHA256 of the contents of the 3D object.
-            - repo (str): Name of the GitHub repo where the 3D object comes from.
-            - organization (str): Name of the GitHub organization where the 3D object
-                comes from.
+            - metadata (Dict[str, Any]): Metadata about the 3D object, including the
+                GitHub organization and repo names.
             Return is not used. Defaults to None.
         handle_new_object (Optional[Callable], optional): Called when a new object is
             found. Here, the object is not used in Objaverse-XL, but is still downloaded
             with the repository. The object may have not been used because it does not
             successfully import into Blender. If None, the object will be downloaded,
             but nothing will be done with it. Args for the function include:
-            - file (str): Local path to the downloaded 3D object.
-            - github_url (str): GitHub URL of the 3D object.
+            - local_path (str): Local path to the downloaded 3D object.
+            - file_identifier (str): GitHub URL of the 3D object.
             - sha256 (str): SHA256 of the contents of the 3D object.
-            - repo (str): Name of the GitHub repo where the 3D object comes from.
-            - organization (str): Name of the GitHub organization where the 3D object
-                comes from.
+            - metadata (Dict[str, 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,
@@ -459,21 +453,23 @@ def download_github_objects(
             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:
-            - file (str): Local path to the downloaded 3D object.
-            - github_url (str): GitHub URL of the 3D object.
-            - sha256 (str): SHA256 of the contents of the 3D object.
-            - repo (str): Name of the GitHub repo where the 3D object comes from.
-            - organization (str): Name of the GitHub organization where the 3D object
-                comes from.
+            - local_path (str): Local path to the downloaded 3D object.
+            - file_identifier (str): GitHub URL 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[str, Any]): Metadata about the 3D object, including the
+                GitHub organization and repo names.
             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:
-            - github_url (str): GitHub URL of the 3D object.
+            - file_identifier (str): GitHub URL of the 3D object.
             - sha256 (str): SHA256 of the contents of the original 3D object.
-            - repo (str): Name of the GitHub repo where the 3D object comes from.
-            - organization (str): Name of the GitHub organization where the 3D object comes from.
+            - metadata (Dict[str, Any]): Metadata about the 3D object, including the
+                GitHub organization and repo names.
             Return is not used. Defaults to None.
 
     Returns:
@@ -531,7 +527,7 @@ def download_github_objects(
     ]
 
     logger.info(
-        f"Found {len(repo_ids_to_download)} not yet downloaded. Downloading now..."
+        f"Found {len(repo_ids_to_download)} repoIds not yet downloaded. Downloading now..."
     )
 
     # get the objects to download

scripts/rendering/main.py

@@ -9,7 +9,7 @@ import tempfile
 import time
 import zipfile
 from functools import partial
-from typing import List, Literal, Optional, Union
+from typing import List, Literal, Optional, Union, Dict, Any, Callable
 
 import fire
 import fsspec
@@ -21,23 +21,23 @@ from objaverse_xl.github import download_github_objects
 from objaverse_xl.utils import get_uid_from_str
 
 
-def log_processed_object(object_id: str, sha256: str, csv_filename: str) -> None:
+def log_processed_object(csv_filename: str, *args) -> None:
     """Log when an object is done being used.
 
     Args:
-        object_id (str): ID of the object.
-        sha256 (str): SHA256 of the object.
         csv_filename (str): Name of the CSV file to save the logs to.
+        *args: Arguments to save to the CSV file.
 
     Returns:
         None
     """
+    args = ",".join([str(arg) for arg in args])
     # log that this object was rendered successfully
     # saving locally to avoid excessive writes to the cloud
     dirname = os.path.expanduser(f"~/.objaverse/github/logs/")
     os.makedirs(dirname, exist_ok=True)
     with open(os.path.join(dirname, csv_filename), "a", encoding="utf-8") as f:
-        f.write(f"{time.time()},{object_id},{sha256}\n")
+        f.write(f"{time.time()},{args}\n")
 
 
 def zipdir(path: str, ziph: zipfile.ZipFile) -> None:
@@ -59,19 +59,18 @@ def zipdir(path: str, ziph: zipfile.ZipFile) -> None:
 
 
 def handle_found_object(
-    file: str,
-    github_url: str,
+    local_path: str,
+    file_identifier: str,
     sha256: str,
-    repo: str,
-    organization: str,
+    metadata: Dict[str, Any],
     num_renders: int,
     render_dir: str,
     only_northern_hemisphere: bool,
     gpu_devices: Union[int, List[int]],
     render_timeout: int,
-    successful_log_file: str = "handle-found-object-successful.csv",
-    failed_log_file: str = "handle-found-object-failed.csv",
-) -> None:
+    successful_log_file: Optional[str] = "handle-found-object-successful.csv",
+    failed_log_file: Optional[str] = "handle-found-object-failed.csv",
+) -> bool:
     """Called when an object is successfully found and downloaded.
 
     Here, the object has the same sha256 as the one that was downloaded with
@@ -79,12 +78,11 @@ def handle_found_object(
     it.
 
     Args:
-        file (str): Local path to the downloaded 3D object.
-        github_url (str): GitHub URL of the 3D object.
+        local_path (str): Local path to the downloaded 3D object.
+        file_identifier (str): GitHub URL of the 3D object.
         sha256 (str): SHA256 of the contents of the 3D object.
-        repo (str): Name of the GitHub repo where the 3D object comes from.
-        organization (str): Name of the GitHub organization where the 3D object
-            comes from.
+        metadata (Dict[str, Any]): Metadata about the 3D object, including keys for
+            `github_organization` and `github_repo`.
         num_renders (int): Number of renders to save of the object.
         render_dir (str): Directory where the objects will be rendered.
         only_northern_hemisphere (bool): Only render the northern hemisphere of the
@@ -98,11 +96,10 @@ def handle_found_object(
         successful_log_file (str): Name of the log file to save successful renders to.
         failed_log_file (str): Name of the log file to save failed renders to.
 
-    Returns:
-        None
+    Returns: True if the object was rendered successfully, False otherwise.
     """
-    save_uid = get_uid_from_str(github_url)
-    args = f"--object_path '{file}' --num_renders {num_renders}"
+    save_uid = get_uid_from_str(file_identifier)
+    args = f"--object_path '{local_path}' --num_renders {num_renders}"
 
     # get the GPU to use for rendering
     using_gpu: bool = True
@@ -147,8 +144,14 @@ def handle_found_object(
         if using_gpu:
             command = f"export DISPLAY=:0.{gpu_i} && {command}"
 
-        # render the object
-        subprocess.run(["bash", "-c", command], timeout=render_timeout, check=False)
+        # render the object (put in dev null)
+        subprocess.run(
+            ["bash", "-c", command],
+            timeout=render_timeout,
+            check=False,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
 
         # check that the renders were saved successfully
         png_files = glob.glob(os.path.join(target_directory, "*.png"))
@@ -159,25 +162,34 @@ def handle_found_object(
             or (len(npy_files) != num_renders)
             or (len(metadata_files) != 1)
         ):
-            logger.error(f"Found object {github_url} was not rendered successfully!")
-            log_processed_object(github_url, sha256, failed_log_file)
-            return
+            logger.error(
+                f"Found object {file_identifier} was not rendered successfully!"
+            )
+            if failed_log_file is not None:
+                log_processed_object(
+                    failed_log_file,
+                    file_identifier,
+                    sha256,
+                )
+            return False
 
         # update the metadata
-        with open(f"{target_directory}/metadata.json", "r", encoding="utf-8") as f:
-            metadata = json.load(f)
-        metadata["sha256"] = sha256
-        metadata["file_identifier"] = github_url
-        metadata["save_uid"] = save_uid
-        with open(f"{target_directory}/metadata.json", "w", encoding="utf-8") as f:
-            json.dump(metadata, f, sort_keys=True, indent=2)
+        metadata_path = os.path.join(target_directory, "metadata.json")
+        with open(metadata_path, "r", encoding="utf-8") as f:
+            metadata_file = json.load(f)
+        metadata_file["sha256"] = sha256
+        metadata_file["file_identifier"] = file_identifier
+        metadata_file["save_uid"] = save_uid
+        metadata_file["metadata"] = metadata
+        with open(metadata_path, "w", encoding="utf-8") as f:
+            json.dump(metadata, f, indent=2, sort_keys=True)
 
         # Make a zip of the target_directory.
         # Keeps the {save_uid} directory structure when unzipped
         with zipfile.ZipFile(
             f"{target_directory}.zip", "w", zipfile.ZIP_DEFLATED
-        ) as zipf:
-            zipdir(target_directory, zipf)
+        ) as ziph:
+            zipdir(target_directory, ziph)
 
         # move the zip to the render_dir
         fs, path = fsspec.core.url_to_fs(render_dir)
@@ -190,15 +202,17 @@ def handle_found_object(
         )
 
         # log that this object was rendered successfully
-        log_processed_object(github_url, sha256, successful_log_file)
+        if successful_log_file is not None:
+            log_processed_object(successful_log_file, file_identifier, sha256)
+
+        return True
 
 
 def handle_new_object(
-    file: str,
-    github_url: str,
+    local_path: str,
+    file_identifier: str,
     sha256: str,
-    repo: str,
-    organization: str,
+    metadata: Dict[str, Any],
     log_file: str = "handle-new-object.csv",
 ) -> None:
     """Called when a new object is found.
@@ -209,27 +223,26 @@ def handle_new_object(
     done with it.
 
     Args:
-        file (str): Local path to the downloaded 3D object.
-        github_url (str): GitHub URL of the 3D object.
+        local_path (str): Local path to the downloaded 3D object.
+        file_identifier (str): GitHub URL of the 3D object.
         sha256 (str): SHA256 of the contents of the 3D object.
-        repo (str): Name of the GitHub repo where the 3D object comes from.
-        organization (str): Name of the GitHub organization where the 3D object
-            comes from.
+        metadata (Dict[str, Any]): Metadata about the 3D object, including the GitHub
+            organization and repo names.
         log_file (str): Name of the log file to save the handle_new_object logs to.
 
     Returns:
         None
     """
     # log the new object
-    log_processed_object(github_url, sha256, log_file)
+    log_processed_object(log_file, file_identifier, sha256)
 
 
 def handle_modified_object(
-    file: str,
-    github_url: str,
-    sha256: str,
-    repo: str,
-    organization: str,
+    local_path: str,
+    file_identifier: str,
+    new_sha256: str,
+    old_sha256: str,
+    metadata: Dict[str, Any],
     num_renders: int,
     render_dir: str,
     only_northern_hemisphere: bool,
@@ -244,12 +257,13 @@ def handle_modified_object(
     be downloaded, but nothing will be done with it.
 
     Args:
-        file (str): Local path to the downloaded 3D object.
-        github_url (str): GitHub URL of the 3D object.
-        sha256 (str): SHA256 of the contents of the 3D object.
-        repo (str): Name of the GitHub repo where the 3D object comes from.
-        organization (str): Name of the GitHub organization where the 3D object
-            comes from.
+        local_path (str): Local path to the downloaded 3D object.
+        file_identifier (str): GitHub URL 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[str, Any]): Metadata about the 3D object, including the GitHub
+            organization and repo names.
         num_renders (int): Number of renders to save of the object.
         render_dir (str): Directory where the objects will be rendered.
         only_northern_hemisphere (bool): Only render the northern hemisphere of the
@@ -264,27 +278,40 @@ def handle_modified_object(
     Returns:
         None
     """
-    handle_found_object(
-        file=file,
-        github_url=github_url,
-        sha256=sha256,
-        repo=repo,
-        organization=organization,
+    success = handle_found_object(
+        local_path=local_path,
+        file_identifier=file_identifier,
+        sha256=new_sha256,
+        metadata=metadata,
         num_renders=num_renders,
         render_dir=render_dir,
         only_northern_hemisphere=only_northern_hemisphere,
         gpu_devices=gpu_devices,
         render_timeout=render_timeout,
-        successful_log_file="handle-modified-object-successful.csv",
-        failed_log_file="handle-modified-object-failed.csv",
+        successful_log_file=None,
+        failed_log_file=None,
     )
 
+    if success:
+        log_processed_object(
+            "handle-modified-object-successful.csv",
+            file_identifier,
+            old_sha256,
+            new_sha256,
+        )
+    else:
+        log_processed_object(
+            "handle-modified-object-failed.csv",
+            file_identifier,
+            old_sha256,
+            new_sha256,
+        )
+
 
 def handle_missing_object(
     github_url: str,
     sha256: str,
-    repo: str,
-    organization: str,
+    metadata: Dict[str, Any],
     log_file: str = "handle-missing-object.csv",
 ) -> None:
     """Called when an object that is in Objaverse-XL is not found.
@@ -295,38 +322,20 @@ def handle_missing_object(
     Args:
         github_url (str): GitHub URL of the 3D object.
         sha256 (str): SHA256 of the contents of the original 3D object.
-        repo (str): Name of the GitHub repo where the 3D object comes from.
-        organization (str): Name of the GitHub organization where the 3D object comes from.
+        metadata (Dict[str, Any]): Metadata about the 3D object, including the GitHub
+            organization and repo names.
         log_file (str): Name of the log file to save missing renders to.
 
     Returns:
         None
     """
     # log the missing object
-    log_processed_object(github_url, sha256, log_file)
+    log_processed_object(log_file, github_url, sha256)
 
 
 def get_example_objects() -> pd.DataFrame:
     """Returns a DataFrame of example objects to use for debugging."""
-    return pd.DataFrame(
-        [
-            {
-                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.fbx",
-                "license": None,
-                "sha256": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
-            },
-            {
-                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.glb",
-                "license": None,
-                "sha256": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
-            },
-            {
-                "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/6928b08a2501aa7a4a4aabac1f888b66e7782056/example.obj",
-                "license": None,
-                "sha256": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
-            },
-        ]
-    )
+    return pd.read_json("example-objects.json", orient="records")
 
 
 def render_github_objects(