auto-patch README.md

README.md

@@ -1,6 +1,145 @@
+---
+base_model: appmana/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf
+extra_gated_button_content: Submit
+extra_gated_fields:
+  ? By clicking Submit below, I accept the terms of the NVIDIA Open Model License
+    Agreement and acknowledge that I am an adult of legal age of majority in the country
+    in which the Cosmos Models will be used and have authority to accept this Agreement
+  : checkbox
+extra_gated_prompt: |2-
+
+  This is a Hugging Face `transformers` compatible repository with .safetensors conversion of the Cosmos Prompt Upsampler fine tuning of mistral-nemo-instruct-12b
+  # NVIDIA Open Model License Agreement
+  Version Release Date: January 6, 2025
+  This NVIDIA Open Model License Agreement (the "<ins>Agreement</ins>") is a legal agreement between the Legal Entity You represent, or if no entity is identified, You and NVIDIA Corporation and its Affiliates ("<ins>NVIDIA</ins>") and governs Your use of the Models that NVIDIA provides to You under this Agreement. NVIDIA and You are each a "<ins>party</ins>" and collectively the "<ins>parties</ins>."
+  NVIDIA models released under this Agreement are intended to be used permissively and enable the further development of AI technologies. Subject to the terms of this Agreement, NVIDIA confirms that:
+  * Models are commercially usable.
+  * You are free to create and distribute Derivative Models.
+  * NVIDIA does not claim ownership to any outputs generated using the Models or Model Derivatives.
+  By using, reproducing, modifying, distributing, performing or displaying any portion or element of the Model or Derivative Model, or otherwise accepting the terms of this Agreement, you agree to be bound by this Agreement.
+  ## 1. Definitions
+  The following definitions apply to this Agreement:
+
+    1.1. "<ins>NVIDIA Cosmos Model</ins>" means a multimodal Model shared under this Agreement.
+
+    1.2. "<ins>Derivative Model</ins>" means all (a) modifications to the Model, (b) works based on the Model, and (c) any other derivative works of the Model. An output is not a Derivative Model.
+
+    1.3. "<ins>Legal Entity</ins>" means the union of the acting entity and all other entities that <ins>control</ins>, are controlled by, or are under common control with that entity. For the purposes of this definition, "<ins>control</ins>" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of fifty percent (50%) or more of the outstanding shares, or (c) beneficial ownership of such entity.
+
+    1.4. "<ins>Model</ins>" means the machine learning model, software, checkpoints, learnt weights, algorithms, parameters, configuration files and documentation shared under this Agreement.
+
+    1.5. "<ins>You</ins>" or "<ins>Your</ins>" means an individual or Legal Entity exercising permissions granted by this Agreement.
+
+  ## 2. Conditions for Use, License Grant, AI Ethics and IP Ownership
+
+    2.1. Conditions for Use. The Model and any Derivative Model are subject to additional terms as described in Section 2 and Section 3 of this Agreement and govern Your use. If You institute copyright or patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Model or a Derivative Model constitutes direct or contributory copyright or patent infringement, then any licenses granted to You under this Agreement for that Model or Derivative Model will terminate as of the date such litigation is filed. If You bypass, disable, reduce the efficacy of, or circumvent any technical limitation, safety guardrail or associated safety guardrail hyperparameter, encryption, security, digital rights management, or authentication mechanism contained in the Model, your rights under this Agreement will automatically terminate. NVIDIA may update this Agreement to comply with legal and regulatory requirements at any time and You agree to either comply with any updated license or cease Your copying, use, and distribution of the Model and any Derivative Model.
+
+    2.2. License Grant. The rights granted herein are explicitly conditioned on Your full compliance with the terms of this Agreement. Subject to the terms and conditions of this Agreement, NVIDIA hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, revocable (as stated in Section 2.1) license to publicly perform, publicly display, reproduce, use, create derivative works of, make, have made, sell, offer for sale, distribute (through multiple tiers of distribution) and import the Model.
+
+    2.3. AI Ethics. Use of the Models under the Agreement must be consistent with NVIDIA's Trustworthy AI terms found at https://www.nvidia.com/en-us/agreements/trustworthy-ai/terms/.
+
+    2.4. NVIDIA owns the Model and any Model Derivatives created by NVIDIA. Subject to NVIDIA's underlying ownership rights in the Model or its Model Derivatives, You are and will be the owner of Your Model Derivatives. NVIDIA claims no ownership rights in outputs. You are responsible for outputs and their subsequent uses. Except as expressly granted in this Agreement, (a) NVIDIA reserves all rights, interests and remedies in connection with the Model and (b) no other license or right is granted to you by implication, estoppel or otherwise.
+
+  ## 3. Redistribution
+  You may reproduce and distribute copies of the Model or Derivative Models thereof in any medium, with or without modifications, provided that You meet the following conditions:
+
+    3.1. If you distribute the Model, You must give any other recipients of the Model a copy of this Agreement and include the following attribution notice within a "Notice" text file with such copies: "Licensed by NVIDIA Corporation under the NVIDIA Open Model License";
+
+    3.2. If you distribute or make available a NVIDIA Cosmos Model, or a product or service (including an AI model) that contains or uses a NVIDIA Cosmos Model, use a NVIDIA Cosmos Model to create a Derivative Model, or use a NVIDIA Cosmos Model or its outputs to create, train, fine tune, or otherwise improve an AI model, you will include "Built on NVIDIA Cosmos" on a related website, user interface, blogpost, about page, or product documentation; and
+
+    3.3. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Models as a whole, provided Your use, reproduction, and distribution of the Model otherwise complies with the conditions stated in this Agreement.
+
+  ## 4. Trademarks
+  This Agreement does not grant permission to use the trade names, trademarks, service marks, or product names of NVIDIA, except as required for reasonable and customary use in describing the origin of the Model and reproducing the content of the "Notice" text file.
+  ## **5. Disclaimer of Warranty**
+  **Unless required by applicable law or agreed to in writing, NVIDIA provides the Model on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Model, Derivative Models and outputs and assume any risks associated with Your exercise of permissions under this Agreement.**
+  ## **6. Limitation of Liability**
+  **In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, will NVIDIA be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this Agreement or out of the use or inability to use the Model, Derivative Models or outputs (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if NVIDIA has been advised of the possibility of such damages.**
+  ## 7. Indemnity
+  You will indemnify and hold harmless NVIDIA from and against any claim by any third party arising out of or related to your use or distribution of the Model, Model Derivatives or outputs.
+  ## 8. Feedback
+  NVIDIA appreciates your feedback, and You agree that NVIDIA may use it without restriction or compensation to You.
+  ## 9. Governing Law
+  This Agreement will be governed in all respects by the laws of the United States and the laws of the State of Delaware, without regard to conflict of laws principles or the United Nations Convention on Contracts for the International Sale of Goods. The state and federal courts residing in Santa Clara County, California will have exclusive jurisdiction over any dispute or claim arising out of or related to this Agreement, and the parties irrevocably consent to personal jurisdiction and venue in those courts; except that, either party may apply for injunctive remedies or an equivalent type of urgent legal relief in any jurisdiction.
+  ## 10. Trade and Compliance
+  You agree to comply with all applicable export, import, trade and economic sanctions laws and regulations, as amended, including without limitation U.S. Export Administration Regulations and Office of Foreign Assets Control regulations. These laws include restrictions on destinations, end-users and end-use.
+language:
+- en
+library_name: transformers
+license: other
+license_link: https://www.nvidia.com/en-us/agreements/enterprise-software/nvidia-open-model-license
+license_name: nvidia-open-model-license
+quantized_by: mradermacher
+tags:
+- nvidia
+- nemo
+- cosmos
+---
+## About
+
 <!-- ### quantize_version: 2 -->
 <!-- ### output_tensor_quantised: 1 -->
 <!-- ### convert_type: hf -->
 <!-- ### vocab_type:  -->
 <!-- ### tags: nicoboss -->
 weighted/imatrix quants of https://huggingface.co/appmana/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf
+
+<!-- provided-files -->
+static quants are available at https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-GGUF
+## Usage
+
+If you are unsure how to use GGUF files, refer to one of [TheBloke's
+READMEs](https://huggingface.co/TheBloke/KafkaLM-70B-German-V0.1-GGUF) for
+more details, including on how to concatenate multi-part files.
+
+## Provided Quants
+
+(sorted by size, not necessarily quality. IQ-quants are often preferable over similar sized non-IQ quants)
+
+| Link | Type | Size/GB | Notes |
+|:-----|:-----|--------:|:------|
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ1_S.gguf) | i1-IQ1_S | 3.1 | for the desperate |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ1_M.gguf) | i1-IQ1_M | 3.3 | mostly desperate |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ2_XXS.gguf) | i1-IQ2_XXS | 3.7 |  |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ2_XS.gguf) | i1-IQ2_XS | 4.0 |  |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ2_S.gguf) | i1-IQ2_S | 4.2 |  |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ2_M.gguf) | i1-IQ2_M | 4.5 |  |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q2_K_S.gguf) | i1-Q2_K_S | 4.6 | very low quality |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q2_K.gguf) | i1-Q2_K | 4.9 | IQ3_XXS probably better |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ3_XXS.gguf) | i1-IQ3_XXS | 5.0 | lower quality |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ3_XS.gguf) | i1-IQ3_XS | 5.4 |  |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q3_K_S.gguf) | i1-Q3_K_S | 5.6 | IQ3_XS probably better |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ3_S.gguf) | i1-IQ3_S | 5.7 | beats Q3_K* |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ3_M.gguf) | i1-IQ3_M | 5.8 |  |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q3_K_M.gguf) | i1-Q3_K_M | 6.2 | IQ3_S probably better |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q3_K_L.gguf) | i1-Q3_K_L | 6.7 | IQ3_M probably better |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ4_XS.gguf) | i1-IQ4_XS | 6.8 |  |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q4_0.gguf) | i1-Q4_0 | 7.2 | fast, low quality |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-IQ4_NL.gguf) | i1-IQ4_NL | 7.2 | prefer IQ4_XS |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q4_K_S.gguf) | i1-Q4_K_S | 7.2 | optimal size/speed/quality |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q4_K_M.gguf) | i1-Q4_K_M | 7.6 | fast, recommended |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q4_1.gguf) | i1-Q4_1 | 7.9 |  |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q5_K_S.gguf) | i1-Q5_K_S | 8.6 |  |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q5_K_M.gguf) | i1-Q5_K_M | 8.8 |  |
+| [GGUF](https://huggingface.co/mradermacher/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf-i1-GGUF/resolve/main/Cosmos-1.0-Prompt-Upsampler-12B-Text2World-hf.i1-Q6_K.gguf) | i1-Q6_K | 10.2 | practically like static Q6_K |
+
+Here is a handy graph by ikawrakow comparing some lower-quality quant
+types (lower is better):
+
+![image.png](https://www.nethype.de/huggingface_embed/quantpplgraph.png)
+
+And here are Artefact2's thoughts on the matter:
+https://gist.github.com/Artefact2/b5f810600771265fc1e39442288e8ec9
+
+## FAQ / Model Request
+
+See https://huggingface.co/mradermacher/model_requests for some answers to
+questions you might have and/or if you want some other model quantized.
+
+## Thanks
+
+I thank my company, [nethype GmbH](https://www.nethype.de/), for letting
+me use its servers and providing upgrades to my workstation to enable
+this work in my free time. Additional thanks to [@nicoboss](https://huggingface.co/nicoboss) for giving me access to his private supercomputer, enabling me to provide many more imatrix quants, at much higher quality, than I would otherwise be able to.
+
+<!-- end -->