nielsr HF Staff commited on
Commit
605a40e
·
verified ·
1 Parent(s): 6ac9ff7

Add model card with metadata and links

Browse files

This PR adds a model card with the necessary metadata, including the `pipeline_tag`, `library_name`, and a placeholder for the `license`. It also includes links to the paper, the project page and GitHub repository. Please review and merge if everything looks correct.

Files changed (1) hide show
  1. README.md +93 -0
README.md ADDED
@@ -0,0 +1,93 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pipeline_tag: image-text-to-text
3
+ library_name: diffusers # This might need to be verified in the repo.
4
+ license: mit # Placeholder - update if needed
5
+ ---
6
+
7
+ <div align="center">
8
+ <br>
9
+ <img src="docs/images/banner.webp" width="1000">
10
+ <h3>Unified Multimodal Discrete Diffusion</h3>
11
+
12
+ [Alexander Swerdlow](https://aswerdlow.com/)<sup>1&#42;</sup>&nbsp;
13
+ [Mihir Prabhudesai](https://mihirp1998.github.io/)<sup>1&#42;</sup>&nbsp;
14
+ [Siddharth Gandhi](hhttps://www.ssgandhi.com/)<sup>1</sup>&nbsp;
15
+ [Deepak Pathak](https://www.cs.cmu.edu/~dpathak/)<sup>1</sup>&nbsp;
16
+ [Katerina Fragkiadaki](https://www.cs.cmu.edu/~katef/)<sup>1</sup>&nbsp;
17
+ <br>
18
+
19
+ <sup>1</sup> Carnegie Mellon University&nbsp;
20
+
21
+ [![ArXiv](https://img.shields.io/badge/ArXiv-<2503.20853>-<COLOR>.svg)](https://arxiv.org/abs/2503.20853) [![Webpage](https://img.shields.io/badge/Webpage-UniDisc-<COLOR>.svg)](https://unidisc.github.io/)
22
+
23
+ <!-- [![Demo](https://img.shields.io/badge/Demo-Custom-<COLOR>.svg)](https://huggingface.co/spaces/todo) -->
24
+
25
+ </div>
26
+
27
+ ## Hugging Face models
28
+
29
+ The UniDisc checkpoints are available on Hugging Face:
30
+ * [Interleaved Image-Text](https://huggingface.co/aswerdlow/unidisc_interleaved)
31
+ * [Non-Interleaved (Static)](https://huggingface.co/aswerdlow/unidisc_non_interleaved)
32
+
33
+ ## Getting Started
34
+
35
+ To install the dependencies, run:
36
+ ```bash
37
+ git submodule update --init --recursive
38
+ uv sync --no-group dev
39
+ uv sync
40
+ ```
41
+
42
+ For a more detailed installation guide, please refer to [INSTALL.md](docs/INSTALL.md).
43
+
44
+ ## Data
45
+
46
+ See [DATA.md](docs/DATA.md) for details on how to download and preprocess the datasets. We provide processing scripts and instructions for all of the used datasets. Additionally, we release a synthetic dataset available [here](https://huggingface.co/datasets/aswerdlow/unidisc_hq) and the corresponding [generation scripts](unidisc/datasets/preprocessing/unidisc_dataset/README.md) as well as the raw data.
47
+
48
+ ## Training
49
+
50
+ See [TRAIN.md](docs/TRAIN.md) for training commands.
51
+
52
+ ## Inference
53
+
54
+ <!-- Inference demo for **TODO**.
55
+ ```
56
+ TODO
57
+ ``` -->
58
+ <!-- <img src="docs/todo.png" width="1000"> -->
59
+
60
+
61
+ Interactive demo:
62
+ ```
63
+ python demo/server.py
64
+ python demo/client_simple_fasthtml.py
65
+ ```
66
+
67
+
68
+ ## Training
69
+
70
+ See [TRAINING.md](docs/TRAINING.md) for details.
71
+
72
+ ## Evaluation
73
+
74
+ See [EVAL.md](docs/EVAL.md) for details.
75
+
76
+
77
+ ### Citation
78
+ To cite our work, please use the following:
79
+ ```
80
+ @article{TODO,
81
+ title={TODO},
82
+ author={TODO},
83
+ journal={arXiv preprint arXiv:TODO},
84
+ year={TODO}
85
+ }
86
+ ```
87
+
88
+ ## Credits
89
+
90
+ This repository is built on top of the following repositories:
91
+
92
+ - [MDLM](https://github.com/kuleshov-group/mdlm)
93
+ - [Lumina-T2X](https://github.com/Alpha-VLLM/Lumina-T2X)