image-pipeline commited on
Commit
8cdf86a
1 Parent(s): df67977

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +85 -155
README.md CHANGED
@@ -1,198 +1,128 @@
1
  ---
2
- library_name: diffusers
3
- ---
4
-
5
- # Model Card for Model ID
6
-
7
- <!-- Provide a quick summary of what the model is/does. -->
8
-
9
-
10
-
11
- ## Model Details
12
-
13
- ### Model Description
14
-
15
- <!-- Provide a longer summary of what this model is. -->
16
-
17
- This is the model card of a 🧨 diffusers model that has been pushed on the Hub. This model card has been automatically generated.
18
-
19
- - **Developed by:** [More Information Needed]
20
- - **Funded by [optional]:** [More Information Needed]
21
- - **Shared by [optional]:** [More Information Needed]
22
- - **Model type:** [More Information Needed]
23
- - **Language(s) (NLP):** [More Information Needed]
24
- - **License:** [More Information Needed]
25
- - **Finetuned from model [optional]:** [More Information Needed]
26
-
27
- ### Model Sources [optional]
28
-
29
- <!-- Provide the basic links for the model. -->
30
-
31
- - **Repository:** [More Information Needed]
32
- - **Paper [optional]:** [More Information Needed]
33
- - **Demo [optional]:** [More Information Needed]
34
-
35
- ## Uses
36
-
37
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
38
-
39
- ### Direct Use
40
-
41
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
42
-
43
- [More Information Needed]
44
-
45
- ### Downstream Use [optional]
46
-
47
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
48
-
49
- [More Information Needed]
50
-
51
- ### Out-of-Scope Use
52
-
53
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
54
-
55
- [More Information Needed]
56
-
57
- ## Bias, Risks, and Limitations
58
-
59
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
60
-
61
- [More Information Needed]
62
-
63
- ### Recommendations
64
 
65
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
66
-
67
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
68
-
69
- ## How to Get Started with the Model
70
-
71
- Use the code below to get started with the model.
72
-
73
- [More Information Needed]
74
-
75
- ## Training Details
76
-
77
- ### Training Data
78
-
79
- <!-- This should link to a Dataset 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. -->
80
-
81
- [More Information Needed]
82
-
83
- ### Training Procedure
84
-
85
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
86
-
87
- #### Preprocessing [optional]
88
-
89
- [More Information Needed]
90
-
91
-
92
- #### Training Hyperparameters
93
-
94
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
95
-
96
- #### Speeds, Sizes, Times [optional]
97
-
98
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
99
-
100
- [More Information Needed]
101
-
102
- ## Evaluation
103
-
104
- <!-- This section describes the evaluation protocols and provides the results. -->
105
-
106
- ### Testing Data, Factors & Metrics
107
-
108
- #### Testing Data
109
-
110
- <!-- This should link to a Dataset Card if possible. -->
111
-
112
- [More Information Needed]
113
-
114
- #### Factors
115
 
116
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
117
 
118
- [More Information Needed]
 
119
 
120
- #### Metrics
121
 
122
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
123
 
124
- [More Information Needed]
125
 
126
- ### Results
127
 
128
- [More Information Needed]
129
 
130
- #### Summary
131
 
132
 
 
133
 
134
- ## Model Examination [optional]
135
 
136
- <!-- Relevant interpretability work for the model goes here -->
137
 
138
- [More Information Needed]
139
 
140
- ## Environmental Impact
141
 
142
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
143
 
144
- 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).
145
 
146
- - **Hardware Type:** [More Information Needed]
147
- - **Hours used:** [More Information Needed]
148
- - **Cloud Provider:** [More Information Needed]
149
- - **Compute Region:** [More Information Needed]
150
- - **Carbon Emitted:** [More Information Needed]
151
 
152
- ## Technical Specifications [optional]
153
 
154
- ### Model Architecture and Objective
155
 
156
- [More Information Needed]
157
 
158
- ### Compute Infrastructure
159
 
160
- [More Information Needed]
161
 
162
- #### Hardware
163
 
164
- [More Information Needed]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
165
 
166
- #### Software
 
167
 
168
- [More Information Needed]
169
 
170
- ## Citation [optional]
171
 
172
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
173
 
174
- **BibTeX:**
175
 
176
- [More Information Needed]
 
 
177
 
178
- **APA:**
 
 
 
179
 
180
- [More Information Needed]
181
 
182
- ## Glossary [optional]
 
 
 
 
 
 
 
183
 
184
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
 
 
 
 
 
 
 
185
 
186
- [More Information Needed]
187
 
188
- ## More Information [optional]
189
 
190
- [More Information Needed]
191
 
192
- ## Model Card Authors [optional]
193
 
194
- [More Information Needed]
 
195
 
196
- ## Model Card Contact
197
 
198
- [More Information Needed]
 
1
  ---
2
+ license: creativeml-openrail-m
3
+ tags:
4
+ - imagepipeline
5
+ - imagepipeline.io
6
+ - text-to-image
7
+ - ultra-realistic
8
+ pinned: false
9
+ pipeline_tag: text-to-image
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
 
11
+ ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
 
13
 
14
+ ## MajicMIX-Sombre-v2
15
+ <img src="" alt="Generated on Image Pipeline" style="border-radius: 10px;">
16
 
 
17
 
 
18
 
19
+ **This checkpoint model is uploaded on [imagepipeline.io](https://imagepipeline.io/)**
20
 
21
+ Model details -
22
 
 
23
 
 
24
 
25
 
26
+ [![Try this model](https://img.shields.io/badge/try_this_model-image_pipeline-BD9319)](https://imagepipeline.io/models/MajicMIX-Sombre-v2?id=486ae67c-a43c-443e-846c-cabcfd115f95/)
27
 
 
28
 
 
29
 
 
30
 
31
+ ## How to try this model ?
32
 
33
+ You can try using it locally or send an API call to test the output quality.
34
 
35
+ Get your `API_KEY` from [imagepipeline.io](https://imagepipeline.io/). No payment required.
36
 
 
 
 
 
 
37
 
 
38
 
 
39
 
 
40
 
41
+ Coding in `php` `javascript` `node` etc ? Checkout our documentation
42
 
43
+ [![documentation](https://img.shields.io/badge/documentation-image_pipeline-blue)](https://docs.imagepipeline.io/docs/introduction)
44
 
 
45
 
46
+ ```python
47
+ import requests
48
+ import json
49
+
50
+ url = "https://imagepipeline.io/sd/text2image/v1/run"
51
+
52
+ payload = json.dumps({
53
+ "model_id": "486ae67c-a43c-443e-846c-cabcfd115f95",
54
+ "prompt": "ultra realistic close up portrait ((beautiful pale cyberpunk female with heavy black eyeliner)), blue eyes, shaved side haircut, hyper detail, cinematic lighting, magic neon, dark red city, Canon EOS R3, nikon, f/1.4, ISO 200, 1/160s, 8K, RAW, unedited, symmetrical balance, in-frame, 8K",
55
+ "negative_prompt": "painting, extra fingers, mutated hands, poorly drawn hands, poorly drawn face, deformed, ugly, blurry, bad anatomy, bad proportions, extra limbs, cloned face, skinny, glitchy, double torso, extra arms, extra hands, mangled fingers, missing lips, ugly face, distorted face, extra legs, anime",
56
+ "width": "512",
57
+ "height": "512",
58
+ "samples": "1",
59
+ "num_inference_steps": "30",
60
+ "safety_checker": false,
61
+ "guidance_scale": 7.5,
62
+ "multi_lingual": "no",
63
+ "embeddings": "",
64
+ "lora_models": "",
65
+ "lora_weights": ""
66
+ })
67
+
68
+ headers = {
69
+ 'Content-Type': 'application/json',
70
+ 'API-Key': 'your_api_key'
71
+ }
72
+
73
+ response = requests.request("POST", url, headers=headers, data=payload)
74
+
75
+ print(response.text)
76
 
77
+ }
78
+ ```
79
 
80
+ Get more ready to use `MODELS` like this for `SD 1.5` and `SDXL` :
81
 
82
+ [![All models](https://img.shields.io/badge/Get%20All%20Models-image_pipeline-BD9319)](https://imagepipeline.io/models)
83
 
84
+ ### API Reference
85
 
86
+ #### Generate Image
87
 
88
+ ```http
89
+ https://api.imagepipeline.io/sd/text2image/v1
90
+ ```
91
 
92
+ | Headers | Type | Description |
93
+ |:----------------------| :------- |:-------------------------------------------------------------------------------------------------------------------|
94
+ | `API-Key` | `str` | Get your `API_KEY` from [imagepipeline.io](https://imagepipeline.io/) |
95
+ | `Content-Type` | `str` | application/json - content type of the request body |
96
 
 
97
 
98
+ | Parameter | Type | Description |
99
+ | :-------- | :------- | :------------------------- |
100
+ | `model_id` | `str` | Your base model, find available lists in [models page](https://imagepipeline.io/models) or upload your own|
101
+ | `prompt` | `str` | Text Prompt. Check our [Prompt Guide](https://docs.imagepipeline.io/docs/SD-1.5/docs/extras/prompt-guide) for tips |
102
+ | `num_inference_steps` | `int [1-50]` | Noise is removed with each step, resulting in a higher-quality image over time. Ideal value 30-50 (without LCM) |
103
+ | `guidance_scale` | `float [1-20]` | Higher guidance scale prioritizes text prompt relevance but sacrifices image quality. Ideal value 7.5-12.5 |
104
+ | `lora_models` | `str, array` | Pass the model_id(s) of LoRA models that can be found in models page |
105
+ | `lora_weights` | `str, array` | Strength of the LoRA effect |
106
 
107
+ ---
108
+ license: creativeml-openrail-m
109
+ tags:
110
+ - imagepipeline
111
+ - imagepipeline.io
112
+ - text-to-image
113
+ - ultra-realistic
114
+ pinned: false
115
+ pipeline_tag: text-to-image
116
 
117
+ ---
118
 
119
+ ### Feedback
120
 
121
+ If you have any feedback, please reach out to us at hello@imagepipeline.io
122
 
 
123
 
124
+ #### 🔗 Visit Website
125
+ [![portfolio](https://img.shields.io/badge/image_pipeline-BD9319?style=for-the-badge&logo=gocd&logoColor=white)](https://imagepipeline.io/)
126
 
 
127
 
128
+ If you are the original author of this model, please [click here](https://airtable.com/apprTaRnJbDJ8ufOx/shr4g7o9B6fWfOlUR) to add credits