Kyle Pearson commited on
Commit
afec961
·
1 Parent(s): 374469f
Files changed (1) hide show
  1. README.md +17 -8
README.md CHANGED
@@ -31,9 +31,16 @@ Rendered using [Splat Viewer](https://huggingface.co/spaces/pearsonkyle/Gaussian
31
 
32
  ## Getting started
33
 
34
- ### 📦 Download the Core ML Model
35
 
36
- Make sure `git-xet` is installed (https://hf.co/docs/hub/git-xet):
 
 
 
 
 
 
 
37
 
38
  ```bash
39
  brew install git-xet
@@ -46,6 +53,7 @@ Clone the model repository:
46
  git clone git@hf.co:pearsonkyle/Sharp-coreml
47
  ```
48
 
 
49
  ### 📱 Run Inference on Apple Devices
50
 
51
  Use the provided [sharp.swift](sharp.swift) inference script to load the model and generate 3D Gaussian splats (PLY) from any image:
@@ -60,6 +68,13 @@ swiftc -O -o run_sharp sharp.swift -framework CoreML -framework CoreImage -frame
60
 
61
  > Inference on an Apple M4 Max takes ~1.9 seconds.
62
 
 
 
 
 
 
 
 
63
  ```bash
64
  Usage: \(execName) [OPTIONS] <model> <input_image> <output.ply>
65
 
@@ -80,12 +95,6 @@ Options:
80
  -h, --help Show this help message
81
  ```
82
 
83
- **CLI Features:**
84
- - Automatic model compilation and caching
85
- - Decimation to reduce point cloud size while preserving visual fidelity
86
- - Input is expected as a standard RGB image; conversion to [0,1] and CHW format happens inside the model
87
- - PLY output compatible with [Splat Viewer](https://huggingface.co/spaces/pearsonkyle/Gaussian-Splat-Viewer), [MetalSplatter](https://github.com/scier/MetalSplatter), and [Three.js](https://threejs.org)
88
-
89
  ## Model Input and Output
90
 
91
  ### 📥 Input
 
31
 
32
  ## Getting started
33
 
34
+ ### 📦 Download the Core ML Model Only
35
 
36
+ ```bash
37
+ pip install huggingface-hub
38
+ huggingface-cli download --include sharp.mlpackage/ --local-dir . pearsonkyle/Sharp-coreml
39
+ ```
40
+
41
+ ### 🧰 Clone the Full Repository
42
+
43
+ This will include the inference and model conversion/validation scripts.
44
 
45
  ```bash
46
  brew install git-xet
 
53
  git clone git@hf.co:pearsonkyle/Sharp-coreml
54
  ```
55
 
56
+
57
  ### 📱 Run Inference on Apple Devices
58
 
59
  Use the provided [sharp.swift](sharp.swift) inference script to load the model and generate 3D Gaussian splats (PLY) from any image:
 
68
 
69
  > Inference on an Apple M4 Max takes ~1.9 seconds.
70
 
71
+ **CLI Features:**
72
+ - Automatic model compilation and caching
73
+ - Decimation to reduce point cloud size while preserving visual fidelity
74
+ - Input is expected as a standard RGB image; conversion to [0,1] and CHW format happens inside the model
75
+ - PLY output compatible with [Splat Viewer](https://huggingface.co/spaces/pearsonkyle/Gaussian-Splat-Viewer), [MetalSplatter](https://github.com/scier/MetalSplatter), and [Three.js](https://threejs.org)
76
+
77
+
78
  ```bash
79
  Usage: \(execName) [OPTIONS] <model> <input_image> <output.ply>
80
 
 
95
  -h, --help Show this help message
96
  ```
97
 
 
 
 
 
 
 
98
  ## Model Input and Output
99
 
100
  ### 📥 Input