Refactor atlas-export.py for improved readability and maintainability

atlas-export.py

@@ -65,6 +65,7 @@ def check_gpu_available() -> bool:
     """Check if GPU is available for computation."""
     try:
         import torch
+
         return torch.cuda.is_available()
     except ImportError:
         return False
@@ -74,52 +75,58 @@ def build_atlas_command(args) -> list:
     """Build the embedding-atlas command with all parameters."""
     # Use uvx to run embedding-atlas with required dependencies
     # Include hf-transfer for faster downloads when HF_HUB_ENABLE_HF_TRANSFER is set
-    cmd = ["uvx", "--with", "datasets", "--with", "hf-transfer", "embedding-atlas"]
-    cmd.append(args.dataset_id)
-    
+    cmd = [
+        "uvx",
+        "--with",
+        "datasets",
+        "--with",
+        "hf-transfer",
+        "embedding-atlas",
+        args.dataset_id,
+    ]
     # Add all optional parameters
     if args.model:
         cmd.extend(["--model", args.model])
-    
+
     # Always specify text column to avoid interactive prompt
     text_col = args.text_column or "text"  # Default to "text" if not specified
     cmd.extend(["--text", text_col])
-    
+
     if args.image_column:
         cmd.extend(["--image", args.image_column])
-    
+
     if args.split:
         cmd.extend(["--split", args.split])
-    
+
     if args.sample:
         cmd.extend(["--sample", str(args.sample)])
-    
+
     if args.trust_remote_code:
         cmd.append("--trust-remote-code")
-    
+
     if not args.compute_embeddings:
         cmd.append("--no-compute-embeddings")
-        
+
         if args.x_column:
             cmd.extend(["--x", args.x_column])
-        
+
         if args.y_column:
             cmd.extend(["--y", args.y_column])
-        
+
         if args.neighbors_column:
             cmd.extend(["--neighbors", args.neighbors_column])
-    
+
     # Add export flag with output path
     export_path = "atlas_export.zip"
     cmd.extend(["--export-application", export_path])
-    
+
     return cmd, export_path
 
 
 def create_space_readme(args) -> str:
     """Generate README.md content for the Space."""
     title = args.space_name.replace("-", " ").title()
-    
+
     readme = f"""---
 title: {title}
 emoji: 🗺️
@@ -141,13 +148,13 @@ Interactive embedding visualization of [{args.dataset_id}](https://huggingface.c
 - Automatic clustering with labels
 - WebGPU-accelerated rendering
 """
-    
+
     if args.model:
         readme += f"\n## Model\n\nEmbeddings generated using: `{args.model}`\n"
-    
+
     if args.sample:
         readme += f"\n## Data\n\nVisualization includes {args.sample:,} samples from the dataset.\n"
-    
+
     readme += """
 ## How to Use
 
@@ -161,21 +168,21 @@ Interactive embedding visualization of [{args.dataset_id}](https://huggingface.c
 
 *Generated with [UV Scripts Atlas Export](https://huggingface.co/uv-scripts)*
 """
-    
+
     return readme
 
 
 def extract_and_prepare_static_files(zip_path: str, output_dir: Path) -> None:
     """Extract the exported atlas ZIP and prepare for static deployment."""
     logger.info(f"Extracting {zip_path} to {output_dir}")
-    
-    with zipfile.ZipFile(zip_path, 'r') as zip_ref:
+
+    with zipfile.ZipFile(zip_path, "r") as zip_ref:
         zip_ref.extractall(output_dir)
-    
+
     # The ZIP should contain index.html and associated files
     if not (output_dir / "index.html").exists():
         raise FileNotFoundError("index.html not found in exported atlas")
-    
+
     logger.info(f"Extracted {len(list(output_dir.iterdir()))} items")
 
 
@@ -184,11 +191,11 @@ def deploy_to_space(
     space_name: str,
     organization: Optional[str] = None,
     private: bool = False,
-    hf_token: Optional[str] = None
+    hf_token: Optional[str] = None,
 ) -> str:
     """Deploy the static files to a HuggingFace Space."""
     api = HfApi(token=hf_token)
-    
+
     # Construct full repo ID
     if organization:
         repo_id = f"{organization}/{space_name}"
@@ -197,9 +204,9 @@ def deploy_to_space(
         user_info = api.whoami()
         username = user_info["name"]
         repo_id = f"{username}/{space_name}"
-    
+
     logger.info(f"Creating Space: {repo_id}")
-    
+
     # Create the Space repository
     try:
         create_repo(
@@ -207,7 +214,7 @@ def deploy_to_space(
             repo_type="space",
             space_sdk="static",
             private=private,
-            token=hf_token
+            token=hf_token,
         )
         logger.info(f"Created new Space: {repo_id}")
     except Exception as e:
@@ -215,39 +222,36 @@ def deploy_to_space(
             logger.info(f"Space {repo_id} already exists, updating...")
         else:
             raise
-    
+
     # Upload all files
     logger.info("Uploading files to Space...")
     upload_folder(
-        folder_path=str(output_dir),
-        repo_id=repo_id,
-        repo_type="space",
-        token=hf_token
+        folder_path=str(output_dir), repo_id=repo_id, repo_type="space", token=hf_token
     )
-    
+
     space_url = f"https://huggingface.co/spaces/{repo_id}"
     logger.info(f"✅ Space deployed successfully: {space_url}")
-    
+
     return space_url
 
 
 def main():
     # Enable HF Transfer for faster downloads if available
     os.environ.setdefault("HF_HUB_ENABLE_HF_TRANSFER", "1")
-    
+
     parser = argparse.ArgumentParser(
         description="Generate and deploy static Embedding Atlas visualizations",
         formatter_class=argparse.RawDescriptionHelpFormatter,
         epilog=__doc__,
     )
-    
+
     # Required arguments
     parser.add_argument(
         "dataset_id",
         type=str,
         help="HuggingFace dataset ID to visualize",
     )
-    
+
     # Space configuration
     parser.add_argument(
         "--space-name",
@@ -265,7 +269,7 @@ def main():
         action="store_true",
         help="Make the Space private",
     )
-    
+
     # Atlas configuration
     parser.add_argument(
         "--model",
@@ -298,7 +302,7 @@ def main():
         action="store_true",
         help="Trust remote code in dataset/model",
     )
-    
+
     # Pre-computed embeddings
     parser.add_argument(
         "--no-compute-embeddings",
@@ -321,7 +325,7 @@ def main():
         type=str,
         help="Column with neighbor indices (for pre-computed)",
     )
-    
+
     # Additional options
     parser.add_argument(
         "--hf-token",
@@ -338,44 +342,52 @@ def main():
         type=str,
         help="Local directory for output (default: temp directory)",
     )
-    
+
     args = parser.parse_args()
-    
+
     # Check GPU availability
     if check_gpu_available():
         logger.info("🚀 GPU detected - may accelerate embedding generation")
     else:
         logger.info("💻 Running on CPU - embedding generation may be slower")
-    
+
     # Login to HuggingFace if needed
     if not args.local_only:
         # Try to get token from various sources
         hf_token = (
-            args.hf_token 
+            args.hf_token
             or os.environ.get("HF_TOKEN")
             or os.environ.get("HUGGING_FACE_HUB_TOKEN")
             or get_token()  # This will check HF CLI login
         )
-        
+
         if hf_token:
             login(token=hf_token)
             logger.info("✅ Authenticated with Hugging Face")
         else:
             # Check if running in non-interactive environment (HF Jobs, CI, etc.)
             is_interactive = sys.stdin.isatty()
-            
+
             if is_interactive:
-                logger.warning("No HF token provided. You may not be able to push to the Hub.")
+                logger.warning(
+                    "No HF token provided. You may not be able to push to the Hub."
+                )
                 response = input("Continue anyway? (y/n): ")
-                if response.lower() != 'y':
+                if response.lower() != "y":
                     sys.exit(0)
             else:
                 # In non-interactive environments, fail immediately if no token
-                logger.error("No HF token found. Cannot deploy to Space in non-interactive environment.")
-                logger.error("Please set HF_TOKEN environment variable or use --hf-token argument.")
-                logger.error("Checked: HF_TOKEN, HUGGING_FACE_HUB_TOKEN, and HF CLI login")
+                logger.error(
+                    "No HF token found. Cannot deploy to Space in non-interactive environment."
+                )
+                logger.error(
+                    "Please set HF_TOKEN environment variable or use --hf-token argument."
+                )
+                logger.error(
+                    "Checked: HF_TOKEN, HUGGING_FACE_HUB_TOKEN, and HF CLI login"
+                )
                 sys.exit(1)
-    
+
     # Set up output directory
     if args.output_dir:
         output_dir = Path(args.output_dir)
@@ -385,50 +397,48 @@ def main():
         temp_dir = tempfile.mkdtemp(prefix="atlas_export_")
         output_dir = Path(temp_dir)
         logger.info(f"Using temporary directory: {output_dir}")
-    
+
     try:
         # Build and run embedding-atlas command
         cmd, export_path = build_atlas_command(args)
         logger.info(f"Running command: {' '.join(cmd)}")
-        
+
         # Run the command
         result = subprocess.run(cmd, capture_output=True, text=True)
-        
+
         if result.returncode != 0:
             logger.error(f"Atlas export failed with return code {result.returncode}")
             logger.error(f"STDOUT: {result.stdout}")
             logger.error(f"STDERR: {result.stderr}")
             sys.exit(1)
-        
+
         logger.info("✅ Atlas export completed successfully")
-        
+
         # Extract the exported files
         extract_and_prepare_static_files(export_path, output_dir)
-        
+
         # Create README for the Space
         readme_content = create_space_readme(args)
         (output_dir / "README.md").write_text(readme_content)
-        
+
         if args.local_only:
             logger.info(f"✅ Static files prepared in: {output_dir}")
-            logger.info("To deploy manually, upload the contents to a HuggingFace Space with sdk: static")
+            logger.info(
+                "To deploy manually, upload the contents to a HuggingFace Space with sdk: static"
+            )
         else:
             # Deploy to HuggingFace Space
             space_url = deploy_to_space(
-                output_dir,
-                args.space_name,
-                args.organization,
-                args.private,
-                hf_token
+                output_dir, args.space_name, args.organization, args.private, hf_token
             )
-            
+
             logger.info(f"\n🎉 Success! Your atlas is live at: {space_url}")
             logger.info(f"The visualization will be available in a few moments.")
-        
+
         # Clean up the ZIP file
         if Path(export_path).exists():
             os.remove(export_path)
-        
+
     finally:
         # Clean up temp directory if used
         if temp_dir and not args.local_only:
@@ -443,12 +453,20 @@ if __name__ == "__main__":
         print("# Basic usage:")
         print("uv run atlas-export.py stanfordnlp/imdb --space-name imdb-atlas\n")
         print("# With custom model and sampling:")
-        print("uv run atlas-export.py my-dataset --space-name my-viz --model nomic-ai/nomic-embed-text-v1.5 --sample 10000\n")
+        print(
+            "uv run atlas-export.py my-dataset --space-name my-viz --model nomic-ai/nomic-embed-text-v1.5 --sample 10000\n"
+        )
         print("# For HF Jobs with GPU (experimental UV support):")
-        print("# First get your token: python -c \"from huggingface_hub import get_token; print(get_token())\"")
-        print("hf jobs uv run --flavor t4-small -s HF_TOKEN=your-token-here https://huggingface.co/datasets/uv-scripts/build-atlas/raw/main/atlas-export.py dataset --space-name viz --model sentence-transformers/all-mpnet-base-v2\n")
+        print(
+            '# First get your token: python -c "from huggingface_hub import get_token; print(get_token())"'
+        )
+        print(
+            "hf jobs uv run --flavor t4-small -s HF_TOKEN=your-token-here https://huggingface.co/datasets/uv-scripts/build-atlas/raw/main/atlas-export.py dataset --space-name viz --model sentence-transformers/all-mpnet-base-v2\n"
+        )
         print("# Local generation only:")
-        print("uv run atlas-export.py dataset --space-name test --local-only --output-dir ./atlas-output")
+        print(
+            "uv run atlas-export.py dataset --space-name test --local-only --output-dir ./atlas-output"
+        )
         sys.exit(0)
-    
-    main()
+
+    main()