Upload README.md with huggingface_hub

README.md

@@ -1,5 +1,124 @@
----
-license: other
-license_name: autodesk-non-commercial-3d-generative-v1.0
-license_link: LICENSE
----
+---
+language:
+- en
+license: other
+license_name: autodesk-non-commercial-3d-generative-v1.0
+tags:
+- wala
+- unconditional-3d-generation
+---
+
+# Model Card for WaLa-UN-1B
+
+This model is part of the Wavelet Latent Diffusion (WaLa) paper, capable of generating high-quality 3D shapes unconditionally with detailed geometry and complex structures.
+
+## Model Details
+
+### Model Description
+
+WaLa-UN-1B is a large-scale 3D generative model trained on a massive dataset of over 10 million publicly-available 3D shapes. It can efficiently generate a wide range of high-quality 3D shapes unconditionally in just 2-4 seconds. The model uses a wavelet-based compact latent encoding and a billion-parameter architecture to achieve superior performance in terms of geometric detail and structural plausibility.
+
+- **Developed by:** Aditya Sanghi, Aliasghar Khani, Chinthala Pradyumna Reddy, Arianna Rampini, Derek Cheung, Kamal Rahimi Malekshan, Kanika Madan, Hooman Shayani
+- **Model type:** 3D Generative Model
+- **License:** Autodesk Non-Commercial (3D Generative) v1.0
+
+For more information please look at the [Project](TBD) [Page](TBD) and [the paper](TBD).
+
+### Model Sources
+
+- **Repository:** [Github](https://github.com/AutodeskAILab/WaLa)
+- **Paper:** [ArXiv:TBD](TBD)
+- **Demo:** [TBD](TBD)
+
+## Uses
+
+### Direct Use
+
+This model is released by Autodesk and intended for academic and research purposes only for the theoretical exploration and demonstration of the WaLa 3D generative framework. Please see [here](TBD) for inferencing instructions. 
+
+### Out-of-Scope Use
+
+The model should not be used for:
+
+- Commercial purposes 
+
+- Creation of load-bearing physical objects the failure of which could cause property damage or personal injury 
+
+- Any usage not in compliance with the [license](https://huggingface.co/ADSKAILab/WaLa-UN-1B/blob/main/LICENSE.md), in particular, the "Acceptable Use" section. 
+
+## Bias, Risks, and Limitations
+
+### Bias
+
+- The model may inherit biases present in the publicly-available training datasets, which could lead to uneven representation of certain object types or styles. 
+
+- The model's performance may vary across different object categories, potentially favoring those that are more prevalent in the training data.
+
+### Risks and Limitations
+
+- As an unconditional model, there's no direct control over the type or characteristics of the generated shapes.
+- The model may occasionally generate implausible or unrealistic shapes. Even theoretically plausible shapes should not be relied upon for real-world structural soundness.
+
+## How to Get Started with the Model
+
+Please refer to the instructions [here](TBD)
+
+## Training Details
+
+### Training Data
+
+The model was trained on a dataset of over 10 million 3D shapes aggregated from 19 different publicly-available sub-datasets, including ModelNet, ShapeNet, SMLP, Thingi10K, SMAL, COMA, House3D, ABC, Fusion 360, 3D-FUTURE, BuildingNet, DeformingThings4D, FG3D, Toys4K, ABO, Infinigen, Objaverse, and two subsets of ObjaverseXL (Thingiverse and GitHub).
+
+### Training Procedure
+
+#### Preprocessing
+
+Each 3D shape in the dataset was converted into a truncated signed distance function (TSDF) with a resolution of 256³. The TSDF was then decomposed using a discrete wavelet transform to create the wavelet-tree representation used by the model.
+
+#### Training Hyperparameters
+
+- **Training regime:** Please refer to the paper.
+
+#### Speeds, Sizes, Times
+
+- The model contains approximately 1.1 billion parameters.
+- The model can generate shapes within 2-4 seconds.
+
+## Evaluation
+
+### Testing Data, Factors & Metrics
+
+#### Testing Data
+
+The model was evaluated on the Google Scanned Objects (GSO) dataset and a validation set from the training data (MAS validation data).
+
+#### Factors
+
+The evaluation considered various factors such as the quality of generated shapes, the ability to capture fine details and complex structures, and the model's performance across different object categories.
+
+#### Metrics
+
+The model was evaluated using the following metrics:
+- Intersection over Union (IoU)
+- Light Field Distance (LFD)
+- Chamfer Distance (CD)
+
+### Results
+
+[Specific results for the unconditional model to be added when available]
+
+## Technical Specifications
+
+### Model Architecture and Objective
+
+The model uses a U-ViT architecture with modifications. It employs a wavelet-based compact latent encoding to effectively capture both coarse and fine details of 3D shapes. Unlike the conditional models, this unconditional model does not use any input conditions and generates 3D shapes solely based on random noise inputs.
+
+### Compute Infrastructure
+
+#### Hardware
+
+[TBD]
+
+## Citation
+
+[Citation information to be added after paper publication]