From 904526a77c5a1ffc768177cf40f280a5e3e43628 Mon Sep 17 00:00:00 2001
From: AsherJingkongChen <37398747+AsherJingkongChen@users.noreply.github.com>
Date: Mon, 9 Dec 2024 16:15:30 +0800
Subject: [PATCH] (doc): Report placeholder.

* LOL, the eval is too slow on M2 Pro.
---
 README.md     |   3 +-
 doc/REPORT.md | 100 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 102 insertions(+), 1 deletion(-)
 create mode 100644 doc/REPORT.md

diff --git a/README.md b/README.md
index 2968098..4977e9d 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@
 - **Rust** : Easy development and deployment
 - **3DGS** : 3D scene representation with efficient rasterization
 
-   [![**Gausplat**](https://img.shields.io/badge/Gausplat-FF3D65.svg?style=for-the-badge&logo=gausplat&logoColor=white)](https://github.com/AsherJingkongChen/Gausplat)[![**Rust**](https://img.shields.io/badge/Rust-CE412B.svg?style=for-the-badge&logo=rust&logoColor=white)](https://www.rust-lang.org/)[![**WGPU**](https://img.shields.io/badge/WGPU-009E6C.svg?style=for-the-badge&logo=wgpu&logoColor=white)](https://wgpu.rs/)[![**3DGS**](https://img.shields.io/badge/3DGS-3D65FF.svg?style=for-the-badge&logo=3dgs&logoColor=white)](https://img.shields.io/badge/3DGS-3D65FF.svg?style=for-the-badge&logo=3dgs&logoColor=white)
+  [![**Gausplat**](https://img.shields.io/badge/Gausplat-FF3D65.svg?style=for-the-badge&logo=gausplat&logoColor=white)](https://github.com/AsherJingkongChen/Gausplat)[![**Rust**](https://img.shields.io/badge/Rust-CE412B.svg?style=for-the-badge&logo=rust&logoColor=white)](https://www.rust-lang.org/)[![**WGPU**](https://img.shields.io/badge/WGPU-009E6C.svg?style=for-the-badge&logo=wgpu&logoColor=white)](https://wgpu.rs/)[![**3DGS**](https://img.shields.io/badge/3DGS-3D65FF.svg?style=for-the-badge&logo=3dgs&logoColor=white)](https://img.shields.io/badge/3DGS-3D65FF.svg?style=for-the-badge&logo=3dgs&logoColor=white)
 
 ## Getting Started
 
@@ -55,6 +55,7 @@
 
 - [API](https://asherjingkongchen.github.io/Gausplat/gausplat/index.html)
 - [GitHub Repository](https://github.com/AsherJingkongChen/Gausplat)
+- [Report](https://github.com/AsherJingkongChen/Gausplat/blob/main/doc/REPORT.md)
 
 ## Contributing
 
diff --git a/doc/REPORT.md b/doc/REPORT.md
new file mode 100644
index 0000000..0ce0dc8
--- /dev/null
+++ b/doc/REPORT.md
@@ -0,0 +1,100 @@
+# Report for Gausplat
+
+## Datasets
+
+- Tanks & Temples and Deep Blending (COLMAP) [[link]](https://repo-sam.inria.fr/fungraph/3d-gaussian-splatting/datasets/input/tandt_db.zip)
+  - drjohnson
+  - playroom
+  - train
+  - truck
+
+## Methods
+
+| Name        | Git Commit Hash                            |
+| ----------- | ------------------------------------------ |
+| Gausplat    | `fe65d407fe72e3c1a98a5f041734d36567cfc6fd` |
+| Placeholder | `????????????????????????????????????????` |
+
+## Metrics
+
+| Name         | Description                                |
+| ------------ | ------------------------------------------ |
+| PSNR (⬆)     | Peak Signal-to-Noise Ratio.                |
+| SSIM (⬆)     | Mean Structural Similarity Index.          |
+| LPIPS (⬇)    | Learned Perceptual Image Patch Similarity. |
+| Tr. Time (⬇) | Duration of training in seconds.           |
+| Md. Size (⬇) | Size of the model in bytes.                |
+
+## Evaluation
+
+### Quality
+
+- Device (OS): Apple M2 Pro (macOS 14.6.1)
+
+| Metric | Method      | drjohnson | playroom | train | truck |
+| ------ | ----------- | --------- | -------- | ----- | ----- |
+| PSNR   | Gausplat    |           |          |       |       |
+| PSNR   | Placeholder |           |          |       |       |
+| SSIM   | Gausplat    |           |          |       |       |
+| SSIM   | Placeholder |           |          |       |       |
+| LPIPS  | Gausplat    |           |          |       |       |
+| LPIPS  | Placeholder |           |          |       |       |
+
+- Device (OS): NVIDIA GeForce RTX 4060 (Windows 11)
+
+| Metric | Method      | drjohnson | playroom | train | truck |
+| ------ | ----------- | --------- | -------- | ----- | ----- |
+| PSNR   | Gausplat    |           |          |       |       |
+| PSNR   | Placeholder |           |          |       |       |
+| SSIM   | Gausplat    |           |          |       |       |
+| SSIM   | Placeholder |           |          |       |       |
+| LPIPS  | Gausplat    |           |          |       |       |
+| LPIPS  | Placeholder |           |          |       |       |
+
+### Performance
+
+- Device (OS): Apple M2 Pro (macOS 14.6.1)
+
+| Metric | Method      | drjohnson | playroom | train | truck |
+| ------ | ----------- | --------- | -------- | ----- | ----- |
+| PSNR   | Gausplat    |           |          |       |       |
+| PSNR   | Placeholder |           |          |       |       |
+| SSIM   | Gausplat    |           |          |       |       |
+| SSIM   | Placeholder |           |          |       |       |
+| LPIPS  | Gausplat    |           |          |       |       |
+| LPIPS  | Placeholder |           |          |       |       |
+
+- Device (OS): NVIDIA GeForce RTX 4060 (Windows 11)
+
+| Metric | Method      | drjohnson | playroom | train | truck |
+| ------ | ----------- | --------- | -------- | ----- | ----- |
+| PSNR   | Gausplat    |           |          |       |       |
+| PSNR   | Placeholder |           |          |       |       |
+| SSIM   | Gausplat    |           |          |       |       |
+| SSIM   | Placeholder |           |          |       |       |
+| LPIPS  | Gausplat    |           |          |       |       |
+| LPIPS  | Placeholder |           |          |       |       |
+
+## Ablation Tests
+
+### Learning Rate of Opacity
+
+- Device (OS): Apple M2 Pro (macOS 14.6.1)
+- Method: Gausplat
+
+| Metric   | Opacity LR. | drjohnson | drjohnson | playroom | train | truck |
+| -------- | ----------- | --------- | --------- | -------- | ----- | ----- |
+| PSNR     | 0.05        |           |           |          |       |       |
+| PSNR     | 0.025       |           |           |          |       |       |
+| SSIM     | 0.05        |           |           |          |       |       |
+| SSIM     | 0.025       |           |           |          |       |       |
+| LPIPS    | 0.05        |           |           |          |       |       |
+| LPIPS    | 0.025       |           |           |          |       |       |
+| Tr. Time | 0.05        |           |           |          |       |       |
+| Tr. Time | 0.025       |           |           |          |       |       |
+| Md. Size | 0.05        |           |           |          |       |       |
+| Md. Size | 0.025       |           |           |          |       |       |
+
+## Conclusion
+
+We have room for improvement in quality and performance.