Upload README.md

README.md

@@ -50,7 +50,7 @@ This repo contains GGUF format model files for [Camel AI's CAMEL 13B Combined Da
 <!-- README_GGUF.md-about-gguf start -->
 ### About GGUF
 
-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. GGUF offers numerous advantages over GGML, such as better tokenisation, and support for special tokens. It is also supports metadata, and is designed to be extensible.
+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.
 
 Here is an incomplate list of clients and libraries that are known to support GGUF:
 
@@ -93,7 +93,7 @@ Below is an instruction that describes a task. Write a response that appropriate
 <!-- compatibility_gguf start -->
 ## Compatibility
 
-These quantised GGUFv2 files are compatible with llama.cpp from August 27th onwards, as of commit [d0cee0d36d5be95a0d9088b674dbb27354107221](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221)
+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)
 
 They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
 
@@ -157,7 +157,7 @@ Then click Download.
 I recommend using the `huggingface-hub` Python library:
 
 ```shell
-pip3 install huggingface-hub>=0.17.1
+pip3 install huggingface-hub
 ```
 
 Then you can download any individual model file to the current directory, at high speed, with a command like this:
@@ -186,25 +186,25 @@ pip3 install hf_transfer
 And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
 
 ```shell
-HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/CAMEL-13B-Combined-Data-GGUF camel-13b-combined.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
+HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/CAMEL-13B-Combined-Data-GGUF camel-13b-combined.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
 ```
 
-Windows CLI users: Use `set HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1` before running the download command.
+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_GGUF.md-how-to-run start -->
 ## Example `llama.cpp` command
 
-Make sure you are using `llama.cpp` from commit [d0cee0d36d5be95a0d9088b674dbb27354107221](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
+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 camel-13b-combined.Q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "Below is an instruction that describes a task. Write a response that appropriately completes the request.\n\n### Instruction:\n{prompt}\n\n### Response:"
+./main -ngl 32 -m camel-13b-combined.Q4_K_M.gguf --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "Below is an instruction that describes a task. Write a response that appropriately completes the request.\n\n### Instruction:\n{prompt}\n\n### Response:"
 ```
 
 Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
 
-Change `-c 4096` 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 GGUF file and set by llama.cpp automatically.
 
 If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
 
@@ -218,22 +218,24 @@ Further instructions here: [text-generation-webui/docs/llama.cpp.md](https://git
 
 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.
 
-### How to load this model from Python using ctransformers
+### How to load this model in Python code, using ctransformers
 
 #### First install the package
 
-```bash
+Run one of the following commands, according to your system:
+
+```shell
 # Base ctransformers with no GPU acceleration
-pip install ctransformers>=0.2.24
+pip install ctransformers
 # Or with CUDA GPU acceleration
-pip install ctransformers[cuda]>=0.2.24
-# Or with ROCm GPU acceleration
-CT_HIPBLAS=1 pip install ctransformers>=0.2.24 --no-binary ctransformers
-# Or with Metal GPU acceleration for macOS systems
-CT_METAL=1 pip install ctransformers>=0.2.24 --no-binary ctransformers
+pip install ctransformers[cuda]
+# Or with AMD ROCm GPU acceleration (Linux only)
+CT_HIPBLAS=1 pip install ctransformers --no-binary ctransformers
+# Or with Metal GPU acceleration for macOS systems only
+CT_METAL=1 pip install ctransformers --no-binary ctransformers
 ```
 
-#### Simple example code to load one of these GGUF models
+#### Simple ctransformers example code
 
 ```python
 from ctransformers import AutoModelForCausalLM
@@ -246,7 +248,7 @@ print(llm("AI is going to"))
 
 ## How to use with LangChain
 
-Here's guides on using llama-cpp-python or ctransformers with LangChain:
+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)
@@ -290,6 +292,71 @@ And thank you again to a16z for their generous grant.
 <!-- original-model-card start -->
 # Original model card: Camel AI's CAMEL 13B Combined Data
 
-No original model card was available.
+
+<!-- header start -->
+<div style="width: 100%;">
+    <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><a href="https://discord.gg/Jq4vkcDakD">Chat & support: my new Discord server</a></p>
+    </div>
+    <div style="display: flex; flex-direction: column; align-items: flex-end;">
+        <p><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
+    </div>
+</div>
+<!-- header end -->
+
+# Camel AI's CAMEL 13B Combined Data fp16
+
+These files are pytorch format fp16 model files for [Camel AI's CAMEL 13B Combined Data](https://huggingface.co/camel-ai/CAMEL-13B-Combined-Data).
+
+It is the result of merging and/or converting the source repository to float16.
+
+## Repositories available
+
+* [4-bit GPTQ models for GPU inference](https://huggingface.co/TheBloke/CAMEL-13B-Combined-Data-fp16)
+* [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/CAMEL-13B-Combined-Data-GGML)
+* [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/TheBloke/CAMEL-13B-Combined-Data-fp16)
+
+<!-- footer start -->
+## Discord
+
+For further support, and discussions on these models and AI in general, join us at:
+
+[TheBloke AI's Discord server](https://discord.gg/Jq4vkcDakD)
+
+## Thanks, and how to contribute.
+
+Thanks to the [chirper.ai](https://chirper.ai) team!
+
+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**: Luke from CarbonQuill, Aemon Algiz, Dmitriy Samsonov.
+
+**Patreon special mentions**: Oscar Rangel, Eugene Pentland, Talal Aujan, Cory Kujawski, Luke, Asp the Wyvern, Ai Maven, Pyrater, Alps Aficionado, senxiiz, Willem Michiel, Junyu Yang, trip7s trip, Sebastain Graf, Joseph William Delisle, Lone Striker, Jonathan Leane, Johann-Peter Hartmann, David Flickinger, Spiking Neurons AB, Kevin Schuppel, Mano Prime, Dmitriy Samsonov, Sean Connelly, Nathan LeClaire, Alain Rossmann, Fen Risland, Derek Yates, Luke Pendergrass, Nikolai Manek, Khalefa Al-Ahmad, Artur Olbinski, John Detwiler, Ajan Kanaga, Imad Khwaja, Trenton Dambrowitz, Kalila, vamX, webtim, Illia Dulskyi.
+
+Thank you to all my generous patrons and donaters!
+
+<!-- footer end -->
+
+# Original model card: Camel AI's CAMEL 13B Combined Data
+
+CAMEL-13B-Combined-Data is a chat large language model obtained by finetuning LLaMA-13B model on a total of 229K conversations collected through our [CAMEL](https://arxiv.org/abs/2303.17760) framework, 100K English public conversations from ShareGPT that can be found [here](https://github.com/lm-sys/FastChat/issues/90#issuecomment-1493250773), and 52K instructions from Alpaca dataset that can be found [here](https://github.com/tatsu-lab/stanford_alpaca/blob/761dc5bfbdeeffa89b8bff5d038781a4055f796a/alpaca_data.json). We evaluate our model offline using EleutherAI's language model evaluation harness used by Huggingface's Open LLM Benchmark. CAMEL<sup>*</sup>-13B scores an average of **58.1**, outperfroming LLaMA-30B (58.3), and on par with LLaMA-65B(58.1)!
+
+| Model       | size | ARC-C  (25 shots, acc_norm) | HellaSwag  (10 shots, acc_norm) | MMLU  (5 shots, acc_norm) | TruthfulQA  (0 shot, mc2) | Average | Delta |
+|-------------|:----:|:---------------------------:|:-------------------------------:|:-------------------------:|:-------------------------:|:-------:|-------|
+| LLaMA       |  13B |             50.8            |               78.9              |            37.7           |            39.9           |   51.8  |   -   |
+| Vicuna      |  13B |             47.4            |               75.2              |            39.6           |            49.8           |   53.7  |  1.9  |
+| CAMEL<sup>*</sup>  |  13B |             55.5            |               79.3              |            50.3           |            47.3           |   58.1  |  6.3  |
+| LLaMA  |  65B |             57.8            |               84.2              |            48.8           |            42.3           |   **58.3**  |  6.5  |
+
 
 <!-- original-model-card end -->