Add versions info and project description

README.md

@@ -16,4 +16,75 @@ thumbnail: >-
   https://cdn-uploads.huggingface.co/production/uploads/6346595c9e5f0fe83fc60444/s0fQvcoiSBlH36AXpVwPi.png
 ---
 
+# 3D Viewer
+
+**3D Viewer** is a lightweight web application built with [Gradio](https://gradio.app) that allows users to view 3D models along with their corresponding height map and source images. The app dynamically loads these resources by parsing URL query string parameters, providing a seamless and interactive experience.
+
+## Features
+
+- **3D Model Display:**  
+  Uses `gr.Model3D` to render 3D models dynamically from a URL parameter (`3d`).
+
+- **Image Slider:**  
+  Displays images (height map and source image) using `gr.ImageSlider`. The images are loaded via URL query parameters named `hm` (height map) and `image` (source image).
+
+- **File Upload:**  
+  Includes an `gr.UploadButton` for uploading new file types like `.glb`, `.gltf`, `.obj`, `.png`, `.jpg`, and `.ply`.
+
+- **Custom Theming:**  
+  The interface is styled with the `Surn/Beeuty` theme to ensure a modern and cohesive look.
+
+## How It Works
+
+- **Query String Parsing:**  
+  While running in Gradio, since the Python callback does not operate within a conventional HTTP request context, the app retrieves query string values by using client-side JavaScript. This JavaScript snippet captures the URL parameters and passes them to the Python callback, which then updates the components accordingly.
+
+- **Static Paths:**  
+  The app sets static paths for directories such as `images/`, `models/`, and `assets/` for accessing local resources.
+
+## Getting Started
+
+1. **Install Dependencies:**
+
+   Ensure you have Python 3.12.8 installed and install Gradio (v5.29.0 or compatible):
+
+```pip install gradio==5.29.0```
+
+
+2. **Run the Application:**
+
+   Start the app by executing:
+
+```python app.py```
+
+
+3. **Use the Query String:**
+
+   After launching, the app can load specific resources if you pass the following query parameters in the URL:
+
+   - `3d`: URL for the 3D model (e.g., `?3d=https://example.com/model.glb`)
+   - `hm`: URL for the height map image (e.g., `?hm=https://example.com/heightmap.png`)
+   - `image`: URL for the source image (e.g., `?image=https://example.com/source.png`)
+
+   Example URL:
+
+```http://localhost:7860/?3d=https://example.com/model.glb&hm=https://example.com/heightmap.png&image=https://example.com/source.png```
+
+
+## Project Structure
+
+- **app.py:**  
+  The core application script defining the Gradio interface, callbacks, and dynamic query string processing.
+
+- **README.md:**  
+  This documentation file outlining the project details and configuration.
+
+- **assets, images, models:**  
+  Directories containing static resources such as images, 3D models, and other assets.
+
+## License
+
+This project is licensed under the Apache-2.0 license.
+
+
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

app.py

@@ -1,4 +1,9 @@
 import gradio as gr
+import modules.version_info as version_info
+
+def getVersions():
+    #return html_versions
+    return version_info.versions_html()
 
 def load_data(query_params, model_3d, image_slider):
     # set default values or pull from querystring
@@ -21,23 +26,26 @@ with gr.Blocks(css_paths="style_20250314.css", title="3D viewer", theme='Surn/Be
     gr.Markdown("# 3D Model Viewer")
     
     with gr.Row():
-        model_3d = gr.Model3D(
-            label="3D Model",
-            value=None,
-            height=400
-        )
-        image_slider = gr.ImageSlider(
-            label="Images",
-            value=None,
-            height=400
-        )
+        with gr.Column():
+            model_3d = gr.Model3D(
+                label="3D Model",
+                value=None,
+                height=400
+            )
+            image_slider = gr.ImageSlider(
+                label="Images",
+                value=None,
+                height=400
+            )
         
     with gr.Row():
         upload_btn = gr.UploadButton(
             "Upload",
             file_types=[".glb", ".gltf", ".obj", ".png", ".jpg", ".ply"]
         )
-        
+    with gr.Row():
+        gr.HTML(value=getVersions(), visible=True, elem_id="versions")
+    
     # Use JavaScript to pass the query parameters to your callback.
     viewer3d.load(
         load_data,

modules/version_info.py

@@ -0,0 +1,127 @@
+# modules/version_info.py
+
+import subprocess
+import os
+import sys
+import gc
+import gradio as gr
+
+git = os.environ.get('GIT', "git")
+
+def commit_hash():
+    try:
+        return subprocess.check_output([git, "rev-parse", "HEAD"], shell=False, encoding='utf8').strip()
+    except Exception:
+        return "<none>"
+
+def get_xformers_version():
+    try:
+        import xformers
+        return xformers.__version__
+    except Exception:
+        return "<none>"
+def get_transformers_version():
+    try:
+        import transformers
+        return transformers.__version__
+    except Exception:
+        return "<none>"
+
+def get_accelerate_version():
+    try:
+        import accelerate
+        return accelerate.__version__
+    except Exception:
+        return "<none>"
+def get_safetensors_version():
+    try:
+        import safetensors
+        return safetensors.__version__
+    except Exception:
+        return "<none>"
+def get_diffusers_version():
+    try:
+        import diffusers
+        return diffusers.__version__
+    except Exception:
+        return "<none>"
+def get_open3d_version():
+    try:
+        import open3d 
+        return f"{open3d.__version__} cuda:{open3d.core.cuda.is_available()}"
+    except Exception:
+        return "<none>"
+
+def get_torch_info():
+    from torch import __version__ as torch_version_, version, cuda, backends
+    initialize_cuda()
+    try:
+        info = [torch_version_, f"CUDA Version:{version.cuda}", f"Available:{cuda.is_available()}", f"flash attention enabled: {backends.cuda.flash_sdp_enabled()}", f"Capabilities: {cuda.get_device_capability(0)}", f"Device Name: {cuda.get_device_name(0)}", f"Device Count: {cuda.device_count()}",f"Devices: {os.environ['CUDA_VISIBLE_DEVICES']}", f"Zero :{os.environ['CUDA_MODULE_LOADING']}"]
+        del torch_version_, version, cuda, backends
+        return info
+    except Exception:
+        del torch_version_, version, cuda, backends
+        return "<none>"
+
+def release_torch_resources():
+    from torch import cuda
+    if cuda.is_available():
+        # Clear the CUDA cache
+        cuda.empty_cache()
+        cuda.ipc_collect()
+        # Delete any objects that are using GPU memory
+        #for obj in gc.get_objects():
+        #    if is_tensor(obj) or (hasattr(obj, 'data') and is_tensor(obj.data)):
+        #        del obj
+        # Run garbage collection
+        del cuda
+        gc.collect()
+
+
+def initialize_cuda():
+    from torch import cuda, version
+    if cuda.is_available():
+        device = cuda.device("cuda")
+        print(f"CUDA is available. Using device: {cuda.get_device_name(0)} with CUDA version: {version.cuda}")
+        result = "cuda"
+    else:
+        #device = cuda.device("cpu")
+        print("CUDA is not available. Using CPU.")
+        result = "cpu"
+    return result
+
+def versions_html():
+    from torch import __version__ as torch_version_
+    python_version = ".".join([str(x) for x in sys.version_info[0:3]])
+    commit = commit_hash()
+
+    # Define the Toggle Dark Mode link with JavaScript
+    toggle_dark_link = '''
+        <a href="#" onclick="document.body.classList.toggle('dark'); return false;" style="cursor: pointer; text-decoration: underline;">
+            Toggle Dark Mode
+        </a>
+    '''
+
+    v_html = f"""
+        version: <a href="https://huggingface.co/spaces/Surn/3D-Viewer/commit/{"huggingface" if commit == "<none>" else commit}" target="_blank">{"huggingface" if commit == "<none>" else commit}</a>
+        &#x2000;•&#x2000;
+        python: <span title="{sys.version}">{python_version}</span>
+        &#x2000;•&#x2000;
+        torch: {torch_version_}
+        &#x2000;•&#x2000;
+        diffusers: {get_diffusers_version()}
+        &#x2000;•&#x2000;
+        transformers: {get_transformers_version()}
+        &#x2000;•&#x2000;
+        safetensors: {get_safetensors_version()}
+        &#x2000;•&#x2000;
+        open3d: {get_open3d_version()}
+        &#x2000;•&#x2000;
+        gradio: {gr.__version__}
+        &#x2000;•&#x2000;
+        {toggle_dark_link}
+        <br>
+        Full GPU Info:{get_torch_info()}
+        """
+    del torch_version_
+    return v_html