Tohru127 commited on
Commit
d970abc
·
verified ·
1 Parent(s): 1b961ee

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +2 -46
README.md CHANGED
@@ -1,50 +1,6 @@
1
  ---
2
- title: Sparse Image to 3D GIS
3
- emoji: 🗺️
4
- colorFrom: green
5
- colorTo: blue
6
  sdk: gradio
7
- sdk_version: 5.46.0
8
  app_file: app.py
9
  pinned: false
10
- ---
11
-
12
- # Hugging Face Space Skeleton
13
-
14
- This folder contains a reference implementation of a Hugging Face Space that turns a bundle of sparse photographs into a previewable 3D reconstruction. It assumes the heavy lifting is performed by COLMAP, Nerfstudio, and 3D Gaussian Splatting.
15
-
16
- ## Files
17
-
18
- | File | Purpose |
19
- | --- | --- |
20
- | `app.py` | Gradio application that orchestrates preprocessing, reconstruction backends, and artifact export. |
21
- | `requirements.txt` | Python dependencies installed by the Space runtime. |
22
- | `packages.txt` | `apt` packages Hugging Face installs before pip dependencies (COLMAP prerequisites). |
23
- | `assets/demo.zip` | Drop a miniature dataset here for automated smoke tests (optional). |
24
- | `external/gaussian-splatting/` | (Optional) place the upstream Gaussian Splatting repo here if you want to expose that backend. |
25
-
26
- ## Running locally
27
-
28
- ```bash
29
- python -m venv .venv # optional but recommended
30
- source .venv/bin/activate
31
- pip install --upgrade pip
32
- pip install -r requirements.txt
33
-
34
- # Optional: only if you want Gaussian Splatting available
35
- git clone https://github.com/graphdeco-inria/gaussian-splatting.git external/gaussian-splatting
36
-
37
- # Launch the interface
38
- python app.py
39
- ```
40
-
41
- Open http://localhost:7860 to access the Gradio UI. Override `HF3D_OUTPUT_ROOT` to choose where run artifacts are stored and `GAUSSIAN_SPLATTING_ROOT` if the repository lives somewhere else on disk.
42
-
43
- ## Deploying to Hugging Face Spaces
44
-
45
- 1. Create a new Space with the **Gradio** SDK and GPU hardware.
46
- 2. Upload the contents of this folder to the Space repository (or set it as a Git submodule).
47
- 3. If you modify dependencies, rebuild the Space and monitor logs for compilation errors (Gaussian Splatting requires CUDA).
48
- 4. Enable persistent storage to cache COLMAP databases, Gaussian point clouds, and Nerfstudio checkpoints.
49
-
50
- See the root documentation for more context and pipeline details.
 
1
  ---
2
+ title: Sparse2City3D
 
 
 
3
  sdk: gradio
 
4
  app_file: app.py
5
  pinned: false
6
+ ---