Add README.md to repo

README.md

@@ -28,40 +28,38 @@ quantized_by: TheBloke
 <!-- header start -->
 <!-- 200823 -->
 <div style="width: auto; margin-left: auto; margin-right: auto">
-<img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
 </div>
 <div style="display: flex; justify-content: space-between; width: 100%;">
  <div style="display: flex; flex-direction: column; align-items: flex-start;">
- <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/FwAVVu7eJ4">Chat & support: jartine's Discord server</a></p>
  </div>
  <div style="display: flex; flex-direction: column; align-items: flex-end;">
- <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
  </div>
 </div>
-<div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">TheBloke's LLM work is generously supported by a grant from <a href="https://a16z.com">andreessen horowitz (a16z)</a></p></div>
+<div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">jartine's LLM work is generously supported by a grant from <a href="https://mozilla.org">mozilla</a></p></div>
 <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
 <!-- header end -->
 
-# Rocket 3B - GGUF
+# Rocket 3B - llamafile
 - Model creator: [pansophic](https://huggingface.co/pansophic)
 - Original model: [Rocket 3B](https://huggingface.co/pansophic/rocket-3B)
 
 <!-- description start -->
 ## Description
 
-This repo contains GGUF format model files for [pansophic's Rocket 3B](https://huggingface.co/pansophic/rocket-3B).
+This repo contains llamafile format model files for [pansophic's Rocket 3B](https://huggingface.co/pansophic/rocket-3B).
 
 These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
 
-<!-- description end -->
-<!-- README_GGUF.md-about-gguf start -->
-### About GGUF
+WARNING: This README may contain inaccuracies. It was generated automatically by forking <a href=/TheBloke/rocket-3B-GGUF>TheBloke/rocket-3B-GGUF</a> and piping the README through sed. Errors should be reported to jartine, and do not reflect TheBloke. You can also support his work on [Patreon](https://www.patreon.com/TheBlokeAI).
+<!-- README_llamafile.md-about-llamafile start -->
+### About llamafile
 
-GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.
+llamafile is a new format introduced by Mozilla Ocho on Nov 20th 2023. It uses Cosmopolitan Libc to turn LLM weights into runnable llama.cpp binaries that run on the stock installs of six OSes for both ARM64 and AMD64.
 
-Here is an incomplete list of clients and libraries that are known to support GGUF:
+Here is an incomplete list of clients and libraries that are known to support llamafile:
 
-* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
+* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for llamafile. Offers a CLI and a server option.
 * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
 * [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
 * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
@@ -71,12 +69,12 @@ Here is an incomplete list of clients and libraries that are known to support GG
 * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
 * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
 
-<!-- README_GGUF.md-about-gguf end -->
+<!-- README_llamafile.md-about-llamafile end -->
 <!-- repositories-available start -->
 ## Repositories available
 
-* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/rocket-3B-GPTQ)
-* [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/rocket-3B-GGUF)
+* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/jartine/rocket-3B-GPTQ)
+* [2, 3, 4, 5, 6 and 8-bit llamafile models for CPU+GPU inference](https://huggingface.co/jartine/rocket-3B-llamafile)
 * [pansophic's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/pansophic/rocket-3B)
 <!-- repositories-available end -->
 
@@ -95,10 +93,10 @@ Here is an incomplete list of clients and libraries that are known to support GG
 <!-- prompt-template end -->
 
 
-<!-- compatibility_gguf start -->
+<!-- compatibility_llamafile start -->
 ## Compatibility
 
-These quantised GGUFv2 files are compatible with llama.cpp from August 27th onwards, as of commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221)
+These quantised llamafilev2 files are compatible with llama.cpp from August 27th onwards, as of commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221)
 
 They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
 
@@ -117,34 +115,34 @@ The new methods available are:
 
 Refer to the Provided Files table below to see what files use which methods, and how.
 </details>
-<!-- compatibility_gguf end -->
+<!-- compatibility_llamafile end -->
 
-<!-- README_GGUF.md-provided-files start -->
+<!-- README_llamafile.md-provided-files start -->
 ## Provided files
 
 | Name | Quant method | Bits | Size | Max RAM required | Use case |
 | ---- | ---- | ---- | ---- | ---- | ----- |
-| [rocket-3b.Q2_K.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q2_K.gguf) | Q2_K | 2 | 1.20 GB| 3.70 GB | smallest, significant quality loss - not recommended for most purposes |
-| [rocket-3b.Q3_K_S.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q3_K_S.gguf) | Q3_K_S | 3 | 1.25 GB| 3.75 GB | very small, high quality loss |
-| [rocket-3b.Q3_K_M.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q3_K_M.gguf) | Q3_K_M | 3 | 1.39 GB| 3.89 GB | very small, high quality loss |
-| [rocket-3b.Q3_K_L.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q3_K_L.gguf) | Q3_K_L | 3 | 1.51 GB| 4.01 GB | small, substantial quality loss |
-| [rocket-3b.Q4_0.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q4_0.gguf) | Q4_0 | 4 | 1.61 GB| 4.11 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
-| [rocket-3b.Q4_K_S.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q4_K_S.gguf) | Q4_K_S | 4 | 1.62 GB| 4.12 GB | small, greater quality loss |
-| [rocket-3b.Q4_K_M.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q4_K_M.gguf) | Q4_K_M | 4 | 1.71 GB| 4.21 GB | medium, balanced quality - recommended |
-| [rocket-3b.Q5_0.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q5_0.gguf) | Q5_0 | 5 | 1.94 GB| 4.44 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
-| [rocket-3b.Q5_K_S.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q5_K_S.gguf) | Q5_K_S | 5 | 1.94 GB| 4.44 GB | large, low quality loss - recommended |
-| [rocket-3b.Q5_K_M.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q5_K_M.gguf) | Q5_K_M | 5 | 1.99 GB| 4.49 GB | large, very low quality loss - recommended |
-| [rocket-3b.Q6_K.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q6_K.gguf) | Q6_K | 6 | 2.30 GB| 4.80 GB | very large, extremely low quality loss |
-| [rocket-3b.Q8_0.gguf](https://huggingface.co/TheBloke/rocket-3B-GGUF/blob/main/rocket-3b.Q8_0.gguf) | Q8_0 | 8 | 2.97 GB| 5.47 GB | very large, extremely low quality loss - not recommended |
+| [rocket-3b.Q2_K.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q2_K.llamafile) | Q2_K | 2 | 1.20 GB| 3.70 GB | smallest, significant quality loss - not recommended for most purposes |
+| [rocket-3b.Q3_K_S.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q3_K_S.llamafile) | Q3_K_S | 3 | 1.25 GB| 3.75 GB | very small, high quality loss |
+| [rocket-3b.Q3_K_M.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q3_K_M.llamafile) | Q3_K_M | 3 | 1.39 GB| 3.89 GB | very small, high quality loss |
+| [rocket-3b.Q3_K_L.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q3_K_L.llamafile) | Q3_K_L | 3 | 1.51 GB| 4.01 GB | small, substantial quality loss |
+| [rocket-3b.Q4_0.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q4_0.llamafile) | Q4_0 | 4 | 1.61 GB| 4.11 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
+| [rocket-3b.Q4_K_S.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q4_K_S.llamafile) | Q4_K_S | 4 | 1.62 GB| 4.12 GB | small, greater quality loss |
+| [rocket-3b.Q4_K_M.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q4_K_M.llamafile) | Q4_K_M | 4 | 1.71 GB| 4.21 GB | medium, balanced quality - recommended |
+| [rocket-3b.Q5_0.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q5_0.llamafile) | Q5_0 | 5 | 1.94 GB| 4.44 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
+| [rocket-3b.Q5_K_S.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q5_K_S.llamafile) | Q5_K_S | 5 | 1.94 GB| 4.44 GB | large, low quality loss - recommended |
+| [rocket-3b.Q5_K_M.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q5_K_M.llamafile) | Q5_K_M | 5 | 1.99 GB| 4.49 GB | large, very low quality loss - recommended |
+| [rocket-3b.Q6_K.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q6_K.llamafile) | Q6_K | 6 | 2.30 GB| 4.80 GB | very large, extremely low quality loss |
+| [rocket-3b.Q8_0.llamafile](https://huggingface.co/jartine/rocket-3B-llamafile/blob/main/rocket-3b.Q8_0.llamafile) | Q8_0 | 8 | 2.97 GB| 5.47 GB | very large, extremely low quality loss - not recommended |
 
 **Note**: the above RAM figures assume no GPU offloading. If layers are offloaded to the GPU, this will reduce RAM usage and use VRAM instead.
 
 
 
-<!-- README_GGUF.md-provided-files end -->
+<!-- README_llamafile.md-provided-files end -->
 
-<!-- README_GGUF.md-how-to-download start -->
-## How to download GGUF files
+<!-- README_llamafile.md-how-to-download start -->
+## How to download llamafile files
 
 **Note for manual downloaders:** You almost never want to clone the entire repo! Multiple different quantisation formats are provided, and most users only want to pick and download a single file.
 
@@ -156,7 +154,7 @@ The following clients/libraries will automatically download models for you, prov
 
 ### In `text-generation-webui`
 
-Under Download Model, you can enter the model repo: TheBloke/rocket-3B-GGUF and below it, a specific filename to download, such as: rocket-3b.Q4_K_M.gguf.
+Under Download Model, you can enter the model repo: jartine/rocket-3B-llamafile and below it, a specific filename to download, such as: rocket-3b.Q4_K_M.llamafile.
 
 Then click Download.
 
@@ -171,7 +169,7 @@ pip3 install huggingface-hub
 Then you can download any individual model file to the current directory, at high speed, with a command like this:
 
 ```shell
-huggingface-cli download TheBloke/rocket-3B-GGUF rocket-3b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
+huggingface-cli download jartine/rocket-3B-llamafile rocket-3b.Q4_K_M.llamafile --local-dir . --local-dir-use-symlinks False
 ```
 
 <details>
@@ -180,7 +178,7 @@ huggingface-cli download TheBloke/rocket-3B-GGUF rocket-3b.Q4_K_M.gguf --local-d
 You can also download multiple files at once with a pattern:
 
 ```shell
-huggingface-cli download TheBloke/rocket-3B-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
+huggingface-cli download jartine/rocket-3B-llamafile --local-dir . --local-dir-use-symlinks False --include='*Q4_K*llamafile'
 ```
 
 For more documentation on downloading with `huggingface-cli`, please see: [HF -> Hub Python Library -> Download files -> Download from the CLI](https://huggingface.co/docs/huggingface_hub/guides/download#download-from-the-cli).
@@ -194,25 +192,25 @@ pip3 install hf_transfer
 And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
 
 ```shell
-HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/rocket-3B-GGUF rocket-3b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
+HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download jartine/rocket-3B-llamafile rocket-3b.Q4_K_M.llamafile --local-dir . --local-dir-use-symlinks False
 ```
 
 Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
 </details>
-<!-- README_GGUF.md-how-to-download end -->
+<!-- README_llamafile.md-how-to-download end -->
 
-<!-- README_GGUF.md-how-to-run start -->
+<!-- README_llamafile.md-how-to-run start -->
 ## Example `llama.cpp` command
 
 Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
 
 ```shell
-./main -ngl 32 -m rocket-3b.Q4_K_M.gguf --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant"
+./main -ngl 32 -m rocket-3b.Q4_K_M.llamafile --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant"
 ```
 
 Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
 
-Change `-c 2048` to the desired sequence length. For extended sequence models - eg 8K, 16K, 32K - the necessary RoPE scaling parameters are read from the GGUF file and set by llama.cpp automatically.
+Change `-c 2048` to the desired sequence length. For extended sequence models - eg 8K, 16K, 32K - the necessary RoPE scaling parameters are read from the llamafile file and set by llama.cpp automatically.
 
 If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
 
@@ -224,7 +222,7 @@ Further instructions can be found in the text-generation-webui documentation, he
 
 ## How to run from Python code
 
-You can use GGUF models from Python using the [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) or [ctransformers](https://github.com/marella/ctransformers) libraries.
+You can use llamafile models from Python using the [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) or [ctransformers](https://github.com/marella/ctransformers) libraries.
 
 ### How to load this model in Python code, using ctransformers
 
@@ -249,7 +247,7 @@ CT_METAL=1 pip install ctransformers --no-binary ctransformers
 from ctransformers import AutoModelForCausalLM
 
 # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
-llm = AutoModelForCausalLM.from_pretrained("TheBloke/rocket-3B-GGUF", model_file="rocket-3b.Q4_K_M.gguf", model_type="stablelm", gpu_layers=50)
+llm = AutoModelForCausalLM.from_pretrained("jartine/rocket-3B-llamafile", model_file="rocket-3b.Q4_K_M.llamafile", model_type="stablelm", gpu_layers=50)
 
 print(llm("AI is going to"))
 ```
@@ -261,7 +259,7 @@ Here are guides on using llama-cpp-python and ctransformers with LangChain:
 * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
 * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
 
-<!-- README_GGUF.md-how-to-run end -->
+<!-- README_llamafile.md-how-to-run end -->
 
 <!-- footer start -->
 <!-- 200823 -->
@@ -269,31 +267,23 @@ Here are guides on using llama-cpp-python and ctransformers with LangChain:
 
 For further support, and discussions on these models and AI in general, join us at:
 
-[TheBloke AI's Discord server](https://discord.gg/theblokeai)
+[jartine AI's Discord server](https://discord.gg/FwAVVu7eJ4)
 
 ## Thanks, and how to contribute
 
-Thanks to the [chirper.ai](https://chirper.ai) team!
 
-Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
 
 I've had a lot of people ask if they can contribute. I enjoy providing models and helping people, and would love to be able to spend even more time doing it, as well as expanding into new projects like fine tuning/training.
 
 If you're able and willing to contribute it will be most gratefully received and will help me to keep providing more models, and to start work on new AI projects.
 
-Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
 
-* Patreon: https://patreon.com/TheBlokeAI
-* Ko-Fi: https://ko-fi.com/TheBlokeAI
 
-**Special thanks to**: Aemon Algiz.
 
-**Patreon special mentions**: Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius
 
 
-Thank you to all my generous patrons and donaters!
 
-And thank you again to a16z for their generous grant.
+And thank you again to mozilla for their generous grant.
 
 <!-- footer end -->