carpedm20 commited on
Commit
81b3979
1 Parent(s): 1fd2dac

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -193
README.md CHANGED
@@ -1,193 +1,13 @@
1
- ---
2
- license: bsd
3
- ---
4
- # Model Card for Model ID
5
-
6
- <!-- Provide a quick summary of what the model is/does. -->
7
-
8
- This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
9
-
10
- # Model Details
11
-
12
- ## Model Description
13
-
14
- <!-- Provide a longer summary of what this model is. -->
15
-
16
-
17
-
18
- - **Developed by:** [More Information Needed]
19
- - **Shared by [optional]:** [More Information Needed]
20
- - **Model type:** [More Information Needed]
21
- - **Language(s) (NLP):** [More Information Needed]
22
- - **License:** [More Information Needed]
23
- - **Finetuned from model [optional]:** [More Information Needed]
24
-
25
- ## Model Sources [optional]
26
-
27
- <!-- Provide the basic links for the model. -->
28
-
29
- - **Repository:** [More Information Needed]
30
- - **Paper [optional]:** [More Information Needed]
31
- - **Demo [optional]:** [More Information Needed]
32
-
33
- # Uses
34
-
35
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
36
-
37
- ## Direct Use
38
-
39
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
40
-
41
- [More Information Needed]
42
-
43
- ## Downstream Use [optional]
44
-
45
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
46
-
47
- [More Information Needed]
48
-
49
- ## Out-of-Scope Use
50
-
51
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
52
-
53
- [More Information Needed]
54
-
55
- # Bias, Risks, and Limitations
56
-
57
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
58
-
59
- [More Information Needed]
60
-
61
- ## Recommendations
62
-
63
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
64
-
65
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
66
-
67
- ## How to Get Started with the Model
68
-
69
- Use the code below to get started with the model.
70
-
71
- [More Information Needed]
72
-
73
- # Training Details
74
-
75
- ## Training Data
76
-
77
- <!-- This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
78
-
79
- [More Information Needed]
80
-
81
- ## Training Procedure [optional]
82
-
83
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
84
-
85
- ### Preprocessing
86
-
87
- [More Information Needed]
88
-
89
- ### Speeds, Sizes, Times
90
-
91
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
92
-
93
- [More Information Needed]
94
-
95
- # Evaluation
96
-
97
- <!-- This section describes the evaluation protocols and provides the results. -->
98
-
99
- ## Testing Data, Factors & Metrics
100
-
101
- ### Testing Data
102
-
103
- <!-- This should link to a Data Card if possible. -->
104
-
105
- [More Information Needed]
106
-
107
- ### Factors
108
-
109
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
110
-
111
- [More Information Needed]
112
-
113
- ### Metrics
114
-
115
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
116
-
117
- [More Information Needed]
118
-
119
- ## Results
120
-
121
- [More Information Needed]
122
-
123
- ### Summary
124
-
125
-
126
-
127
- # Model Examination [optional]
128
-
129
- <!-- Relevant interpretability work for the model goes here -->
130
-
131
- [More Information Needed]
132
-
133
- # Environmental Impact
134
-
135
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
136
-
137
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
138
-
139
- - **Hardware Type:** [More Information Needed]
140
- - **Hours used:** [More Information Needed]
141
- - **Cloud Provider:** [More Information Needed]
142
- - **Compute Region:** [More Information Needed]
143
- - **Carbon Emitted:** [More Information Needed]
144
-
145
- # Technical Specifications [optional]
146
-
147
- ## Model Architecture and Objective
148
-
149
- [More Information Needed]
150
-
151
- ## Compute Infrastructure
152
-
153
- [More Information Needed]
154
-
155
- ### Hardware
156
-
157
- [More Information Needed]
158
-
159
- ### Software
160
-
161
- [More Information Needed]
162
-
163
- # Citation [optional]
164
-
165
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
166
-
167
- **BibTeX:**
168
-
169
- [More Information Needed]
170
-
171
- **APA:**
172
-
173
- [More Information Needed]
174
-
175
- # Glossary [optional]
176
-
177
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
178
-
179
- [More Information Needed]
180
-
181
- # More Information [optional]
182
-
183
- [More Information Needed]
184
-
185
- # Model Card Authors [optional]
186
-
187
- [More Information Needed]
188
-
189
- # Model Card Contact
190
-
191
- [More Information Needed]
192
-
193
-
 
1
+ ```
2
+ from diffusers import StableDiffusionPipeline
3
+ import torch
4
+
5
+ model_id = "carpedm20/test"
6
+ pipe = StableDiffusionPipeline.from_pretrained(model_id, torch_dtype=torch.float16)
7
+ pipe = pipe.to("cuda")
8
+
9
+ prompt = "a photo of an astronaut riding a horse on mars"
10
+ image = pipe(prompt).images[0]
11
+
12
+ image.save("astronaut_rides_horse.png")
13
+ ```