refactor github loading

github/github-urls.parquet

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:3baffd339cae4623b0ac3c77055ca3ff24fef0d75922738a12d9c9623fc33305
-size 794835357
+oid sha256:ac5dba4285a7d4e233f6cff0f538d7e9f6f7410bcbd6e47d565ce0338de5ee75
+size 797464991

objaverse_xl/github.py

@@ -1,6 +1,5 @@
 """Script to download objects from GitHub."""
 
-import hashlib
 import json
 import multiprocessing
 import os
@@ -10,6 +9,7 @@ import tarfile
 import tempfile
 from multiprocessing import Pool
 from typing import Callable, Dict, List, Literal, Optional
+from objaverse_xl.utils import get_file_hash
 
 import fsspec
 import pandas as pd
@@ -42,7 +42,7 @@ def load_github_metadata(download_dir: str = "~/.objaverse") -> pd.DataFrame:
 
     Returns:
         pd.DataFrame: GitHub 3D object metadata as a Pandas DataFrame with columns for
-            the object "githubUrl", "license", and "sha256".
+            the object "fileIdentifier", "license", "source", "fileType", and "sha256".
     """
     filename = os.path.join(download_dir, "github", "github-urls.parquet")
     fs, path = fsspec.core.url_to_fs(filename)
@@ -65,8 +65,8 @@ def load_github_metadata(download_dir: str = "~/.objaverse") -> pd.DataFrame:
 
 
 def _get_repo_id_with_hash(item: pd.Series) -> str:
-    org, repo = item["githubUrl"].split("/")[3:5]
-    commit_hash = item["githubUrl"].split("/")[6]
+    org, repo = item["fileIdentifier"].split("/")[3:5]
+    commit_hash = item["fileIdentifier"].split("/")[6]
     return f"{org}/{repo}/{commit_hash}"
 
 
@@ -112,33 +112,6 @@ def _run_command_with_check(command: List[str], cwd: Optional[str] = None) -> bo
         return False
 
 
-def get_file_hash(file_path: str) -> str:
-    """Get the sha256 hash of a file.
-
-    Args:
-        file_path (str): Path to the file.
-
-    Returns:
-        str: sha256 hash of the file.
-    """
-    # Check if the path is a symbolic link
-    if os.path.islink(file_path):
-        # Resolve the symbolic link
-        resolved_path = os.readlink(file_path)
-        # Check if the resolved path exists
-        if not os.path.exists(resolved_path):
-            raise FileNotFoundError(
-                f"The symbolic link points to a file that doesn't exist: {resolved_path}"
-            )
-    sha256 = hashlib.sha256()
-    # Read the file from the path
-    with open(file_path, "rb") as f:
-        # Loop till the end of the file
-        for byte_block in iter(lambda: f.read(4096), b""):
-            sha256.update(byte_block)
-    return sha256.hexdigest()
-
-
 def _process_repo(
     repo_id: str,
     fs: fsspec.AbstractFileSystem,
@@ -158,12 +131,12 @@ def _process_repo(
         fs (fsspec.AbstractFileSystem): File system to use for saving the repo.
         base_dir (str): Base directory to save the repo to.
         expected_objects (Dict[str, str]): Dictionary of objects that one expects to
-            find in the repo. Keys are the GitHub URLs and values are the sha256 of the
-            objects.
+            find in the repo. Keys are the "fileIdentifier" (i.e., the GitHub URL in
+            this case) and values are the "sha256" of the objects.
         {and the rest of the args are the same as download_github_objects}
 
     Returns:
-        List[Dict[str, str]]: List of dictionaries with the keys "githubUrl" and
+        List[Dict[str, str]]: List of dictionaries with the keys "fileIdentifier" and
             "sha256" for each downloaded object.
     """
     # NOTE: assuming that the user has already checked that the repo doesn't exist,
@@ -238,7 +211,7 @@ def _process_repo(
                 target_directory,
                 f"https://github.com/{org}/{repo}/blob/{repo_commit_hash}",
             )
-            file_hashes.append(dict(sha256=file_hash, githubUrl=github_url))
+            file_hashes.append(dict(sha256=file_hash, fileIdentifier=github_url))
 
             # handle the object under different conditions
             if github_url in expected_objects:
@@ -312,7 +285,7 @@ def _process_repo(
 
     # get each object that was missing from the expected objects
     if handle_missing_object is not None:
-        obtained_urls = {x["githubUrl"] for x in file_hashes}
+        obtained_urls = {x["fileIdentifier"] for x in file_hashes}
         for github_url, sha256 in expected_objects.items():
             if github_url not in obtained_urls:
                 handle_missing_object(
@@ -365,7 +338,7 @@ def _parallel_process_repo(args) -> List[Dict[str, str]]:
         args (Tuple): Tuple of arguments to pass to _process_repo.
 
     Returns:
-        List[Dict[str, str]]: List of dictionaries with the keys "githubUrl" and
+        List[Dict[str, str]]: List of dictionaries with the keys "fileIdentifier" and
             "sha256" for each downloaded object.
     """
 
@@ -398,7 +371,7 @@ def _parallel_process_repo(args) -> List[Dict[str, str]]:
 
 def _process_group(group):
     key, group_df = group
-    return key, group_df.set_index("githubUrl")["sha256"].to_dict()
+    return key, group_df.set_index("fileIdentifier")["sha256"].to_dict()
 
 
 def download_github_objects(
@@ -415,8 +388,8 @@ def download_github_objects(
 
     Args:
         objects (pd.DataFrmae): GitHub objects to download. Must have columns for the
-            object "githubUrl" and "sha256". Use the load_github_metadata function to
-            get the metadata.
+            object "fileIdentifier" and "sha256". Use the load_github_metadata 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 GitHub objects to.
@@ -473,7 +446,7 @@ def download_github_objects(
             Return is not used. Defaults to None.
 
     Returns:
-        List[Dict[str, str]]: List of dictionaries with the keys "githubUrl" and
+        List[Dict[str, str]]: List of dictionaries with the keys "fileIdentifier" and
             "sha256" for each downloaded object.
     """
     if processes is None:

objaverse_xl/utils.py

@@ -1,6 +1,8 @@
 """Utility functions for the objaverse_xl package."""
 
 import uuid
+import os
+import hashlib
 
 
 def get_uid_from_str(string: str) -> str:
@@ -14,3 +16,30 @@ def get_uid_from_str(string: str) -> str:
     """
     namespace = uuid.NAMESPACE_DNS
     return str(uuid.uuid5(namespace, string))
+
+
+def get_file_hash(file_path: str) -> str:
+    """Get the sha256 hash of a file.
+
+    Args:
+        file_path (str): Path to the file.
+
+    Returns:
+        str: sha256 hash of the file.
+    """
+    # Check if the path is a symbolic link
+    if os.path.islink(file_path):
+        # Resolve the symbolic link
+        resolved_path = os.readlink(file_path)
+        # Check if the resolved path exists
+        if not os.path.exists(resolved_path):
+            raise FileNotFoundError(
+                f"The symbolic link points to a file that doesn't exist: {resolved_path}"
+            )
+    sha256 = hashlib.sha256()
+    # Read the file from the path
+    with open(file_path, "rb") as f:
+        # Loop till the end of the file
+        for byte_block in iter(lambda: f.read(4096), b""):
+            sha256.update(byte_block)
+    return sha256.hexdigest()

scripts/rendering/example-objects.json

@@ -1,42 +1,42 @@
 [
   {
     "sha256": "d2b9a5d7c47dc93526082c9b630157ab6bce4fd8669610d942176f4a36444e71",
-    "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.obj"
+    "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.obj"
   },
   {
     "sha256": "f15f7541614940dedd1ce373dee9cde1cc63471db84081259a44488aca267408",
-    "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example-linked.gltf"
+    "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example-linked.gltf"
   },
   {
     "sha256": "cd567dfd1605a5fd60af1b8ac67e44b6af25b9e3f160da66047bb1187d02a071",
-    "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.dae"
+    "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.dae"
   },
   {
     "sha256": "879bc9d2d85e4f3866f0cfef41f5236f9fff5f973380461af9f69cdbed53a0da",
-    "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.abc"
+    "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.abc"
   },
   {
     "sha256": "ac69da6df0c83b593902c71238a7721f575233723730150230da95d583466562",
-    "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.blend"
+    "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.blend"
   },
   {
     "sha256": "bc4cc8a78bc57d3c41ddaca9135d2b4e66b59e97846e2b796e5cc6b09c62b273",
-    "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example-embedded.gltf"
+    "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example-embedded.gltf"
   },
   {
     "sha256": "04e6377317d6818e32c5cbd1951e76deb3641bbf4f6db6933046221d5fbf1c5c",
-    "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.glb"
+    "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.glb"
   },
   {
     "sha256": "7037575f47816118e5a34e7c0da9927e1be7be3f5b4adfac337710822eb50fa9",
-    "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.fbx"
+    "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.fbx"
   },
   {
     "sha256": "10fd5944c3fe32cb25fdcf46319cbda250b98bd22fd87fc41de5769b118d5262",
-    "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.stl"
+    "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.stl"
   },
   {
     "sha256": "aa5c41753ad8a91562122d8cafbe1a940146fc3d227b7086eb8c830da36cb42b",
-    "githubUrl": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.ply"
+    "fileIdentifier": "https://github.com/mattdeitke/objaverse-xl-test-files/blob/ead0bed6a76012452273bbe18d12e4d68a881956/example.ply"
   }
 ]