csris commited on
Commit
9b337d3
1 Parent(s): eb5a72e

Adding a skeleton model card

Browse files

Adding a skeleton model card with the Apache 2.0 license.

Files changed (1) hide show
  1. README.md +120 -0
README.md CHANGED
@@ -1,3 +1,123 @@
1
  ---
2
  license: apache-2.0
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
+ language:
4
+ - en
5
  ---
6
+ # OpenChaT v1
7
+ This model card focuses on the model associated with the OpenChaT model, codebase available [here](https://github.com/togethercomputer/OpenChaT).
8
+
9
+ \[TODO: description\]
10
+ This OpenChaT v1 model is fine-tuned from...
11
+
12
+ ## Model Details
13
+ - **Developed by**: \[TODO\] Together Computer, LAION, ...
14
+ - **Model type**: \[TODO\]
15
+ - **Language(s)**: English
16
+ - **License**: Apache 2.0
17
+ - **Model Description**: \[TODO\]
18
+ - **Resources for more information**: [GitHub Repository](https://github.com/togethercomputer/OpenChaT).
19
+
20
+ **Cite as**
21
+
22
+ \[TODO\]
23
+ @InProceedings{Rombach_2022_CVPR,
24
+ author = {Rombach, Robin and Blattmann, Andreas and Lorenz, Dominik and Esser, Patrick and Ommer, Bj\"orn},
25
+ title = {High-Resolution Image Synthesis With Latent Diffusion Models},
26
+ booktitle = {Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition (CVPR)},
27
+ month = {June},
28
+ year = {2022},
29
+ pages = {10684-10695}
30
+ }
31
+
32
+ ## Examples
33
+ \[TODO\]
34
+
35
+
36
+ # Uses
37
+ \[TODO\]
38
+
39
+ ## Direct Use
40
+ \[TODO\]
41
+
42
+ The model is intended for research purposes only. Possible research areas and tasks include
43
+
44
+ - Safe deployment of models which have the potential to generate harmful content.
45
+ - Probing and understanding the limitations and biases of generative models.
46
+ - Generation of artworks and use in design and other artistic processes.
47
+ - Applications in educational or creative tools.
48
+ - Research on generative models.
49
+
50
+ Excluded uses are described below.
51
+
52
+ ### Misuse, Malicious Use, and Out-of-Scope Use
53
+ \[TODO\]
54
+ _Note: This section is originally taken from the [DALLE-MINI model card](https://huggingface.co/dalle-mini/dalle-mini), was used for Stable Diffusion v1, but applies in the same way to Stable Diffusion v2_.
55
+
56
+ The model should not be used to intentionally create or disseminate images that create hostile or alienating environments for people. This includes generating images that people would foreseeably find disturbing, distressing, or offensive; or content that propagates historical or current stereotypes.
57
+
58
+ #### Out-of-Scope Use
59
+ \[TODO\]
60
+ The model was not trained to be factual or true representations of people or events, and therefore using the model to generate such content is out-of-scope for the abilities of this model.
61
+
62
+ #### Misuse and Malicious Use
63
+ \[TODO\]
64
+ Using the model to generate content that is cruel to individuals is a misuse of this model. This includes, but is not limited to:
65
+
66
+ - Generating demeaning, dehumanizing, or otherwise harmful representations of people or their environments, cultures, religions, etc.
67
+ - Intentionally promoting or propagating discriminatory content or harmful stereotypes.
68
+ - Impersonating individuals without their consent.
69
+ - Sexual content without consent of the people who might see it.
70
+ - Mis- and disinformation
71
+ - Representations of egregious violence and gore
72
+ - Sharing of copyrighted or licensed material in violation of its terms of use.
73
+ - Sharing content that is an alteration of copyrighted or licensed material in violation of its terms of use.
74
+
75
+ ## Limitations and Bias
76
+
77
+ ### Limitations
78
+ \[TODO\]
79
+
80
+ ### Bias
81
+ \[TODO\]
82
+
83
+ ## Training
84
+
85
+ **Training Data**
86
+ \[TODO\]
87
+
88
+ **Training Procedure**
89
+ \[TODO\]
90
+
91
+ \[TODO\]
92
+ - **Hardware:** 32 x 8 x A100 GPUs
93
+ - **Optimizer:** AdamW
94
+ - **Gradient Accumulations**: 1
95
+ - **Batch:** 32 x 8 x 2 x 4 = 2048
96
+ - **Learning rate:** warmup to 0.0001 for 10,000 steps and then kept constant
97
+
98
+ ## Evaluation Results
99
+ \[TODO\]
100
+
101
+ ## Environmental Impact
102
+ \[TODO\]
103
+ **Stable Diffusion v1** **Estimated Emissions**
104
+ Based on that information, we estimate the following CO2 emissions using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700). The hardware, runtime, cloud provider, and compute region were utilized to estimate the carbon impact.
105
+
106
+ - **Hardware Type:** A100 PCIe 40GB
107
+ - **Hours used:** 200000
108
+ - **Cloud Provider:** AWS
109
+ - **Compute Region:** US-east
110
+ - **Carbon Emitted (Power consumption x Time x Carbon produced based on location of power grid):** 15000 kg CO2 eq.
111
+
112
+ ## Citation
113
+ \[TODO\]
114
+ @InProceedings{Rombach_2022_CVPR,
115
+ author = {Rombach, Robin and Blattmann, Andreas and Lorenz, Dominik and Esser, Patrick and Ommer, Bj\"orn},
116
+ title = {High-Resolution Image Synthesis With Latent Diffusion Models},
117
+ booktitle = {Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition (CVPR)},
118
+ month = {June},
119
+ year = {2022},
120
+ pages = {10684-10695}
121
+ }
122
+
123
+ *This model card was written by: \[TODO\]