Update README.md

README.md

@@ -2,197 +2,72 @@
 library_name: diffusers
 ---
 
-# Model Card for Model ID
+# Flux2 Klein 4b Modular repo
 
-<!-- Provide a quick summary of what the model is/does. -->
+This contains mellon config for A single-node Mellon block for the FLUX.2-klein-4B pipeline. 
 
 
+## How to create a modular repo?
 
-## Model Details
+load the pipeline and save it to a new Hub repository:
+```python
+from diffusers import ModularPipeline
 
-### Model Description
+pipe = ModularPipeline.from_pretrained("black-forest-labs/FLUX.2-klein-4B")
+pipe.save_pretrained(
+    "local/dir",
+    repo_id="your-username/flux2-klein-auto-blocks",
+    push_to_hub=True
+)
+```
 
-<!-- Provide a longer summary of what this model is. -->
+## Generate the Mellon Config
 
-This is the model card of a 🧨 diffusers pipeline that has been pushed on the Hub. This model card has been automatically generated.
+Create and push the Mellon configuration with your desired UI types:
+```python
+from diffusers.modular_pipelines.mellon_node_utils import MellonPipelineConfig
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+mellon_config = MellonPipelineConfig.from_custom_block(
+    pipe.blocks,
+    mellon_types={
+        "prompt": "textbox",
+        "image": "image",
+        "images": "image",
+        "num_inference_steps": "number",
+    }
+)
 
-### Model Sources [optional]
+mellon_config.save(
+    local_dir="local/dir",
+    repo_id="your-username/flux2-klein-auto-blocks",
+    push_to_hub=True
+)
+```
 
-<!-- Provide the basic links for the model. -->
+## Review and Adjust
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+The generated `mellon_pipeline_config.json` may need adjustments. You can:
 
-## Uses
+- Remove inputs you don't want exposed in the UI
+- Add slider ranges for numeric inputs
+- Add dropdown options for string inputs
+- update default value for numeric inputs
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
-### Direct Use
+## Use in Mellon
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+1. Drag a **Dynamic Block Node** from the ModularDiffusers section
+2. Enter `your-username/flux2-klein-auto-blocks` as the repo_id
+3. The node will show your configured inputs (prompt, image, num_inference_steps) and outputs (images)
 
-[More Information Needed]
+## Supported Mellon Types
 
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
-
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
-
-## Bias, Risks, and Limitations
-
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
-### Training Data
-
-<!-- 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. -->
-
-[More Information Needed]
-
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
-## Evaluation
-
-<!-- This section describes the evaluation protocols and provides the results. -->
-
-### Testing Data, Factors & Metrics
-
-#### Testing Data
-
-<!-- This should link to a Dataset Card if possible. -->
-
-[More Information Needed]
-
-#### Factors
-
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-
-[More Information Needed]
-
-#### Metrics
-
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-
-[More Information Needed]
-
-### Results
-
-[More Information Needed]
-
-#### Summary
-
-
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
-
-[More Information Needed]
-
-## Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-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).
-
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
-
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
-**BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed]
-
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
-## Model Card Authors [optional]
-
-[More Information Needed]
-
-## Model Card Contact
-
-[More Information Needed]
+| Type | Input/Output | Description |
+|------|--------------|-------------|
+| `image` | Both | Image (PIL Image) |
+| `textbox` | Input | Text input |
+| `number` | Input | Numeric input |
+| `slider` | Input | Slider for numeric values |
+| `dropdown` | Input | Dropdown selection |
+| `checkbox` | Input | Boolean toggle |
+| `text` | Both | Text display |