version bump

cloth-tools/cloth_tools/dataset/download.py

@@ -50,6 +50,16 @@ def get_latest_observation_start_url(server_url: str) -> str:
 
 
 def download_latest_observation(dataset_dir: str, server_url: str) -> tuple[str, str]:
+    """Download the latest start observation's files from the Cloth Competition server.
+    Also returns the sample ID, which must be used when uploading a grasp.json file.
+
+    Args:
+        dataset_dir: The directory to save observation files to.
+        server_url: URL of the server to download from.
+
+    Returns:
+        A tuple containing the path to the observation directory and the sample ID.
+    """
     files_to_retrieve = COMPETITION_OBSERVATION_FILENAMES
     observation_dir_url = get_latest_observation_start_url(server_url)
 

cloth-tools/cloth_tools/dataset/upload.py

@@ -3,9 +3,16 @@
 import requests
 
 
-def upload_grasp(grasp_json_path, team_name, sample_id, server_url):
-    """Uploads a grasp.json file along with team name and sample ID."""
+def upload_grasp(grasp_json_path: str, team_name: str, sample_id: str, server_url: str) -> None:
+    """Uploads a grasp.json file to the Cloth Competition server.
 
+    Args:
+        grasp_json_path: Path to the grasp.json file.
+        team_name: Your team's name, used to organize submissions.
+        sample_id: The ID of the sample that the grasp was generated for, for example: 2024-04-22_09-26-45-537535
+        server_url: URL of the server to upload to.
+
+    """
     upload_url = server_url + "/upload_grasp"
 
     with open(grasp_json_path, "rb") as f:

cloth-tools/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cloth-tools"
-version = "0.3.0"
+version = "0.3.1"
 authors = [
   { name = "Victor-Louis De Gusseme", email = "[email protected]" },
 ]