Update README.md

README.md

@@ -1,3 +1,33 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+language:
+- ar
+- en
+---
+
+# KafkaLM 70B German V0.1 - GGUF
+- Model creator: [Core42](https://huggingface.co/core42)
+- Original model: [Jais-13b](https://huggingface.co/core42/jais-13b)
+
+## Description
+This repo contains GGUF format model files for [Core42's](https://huggingface.co/core42) [JAIS 13B](https://huggingface.co/core42/jais-13b).
+
+## 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.
+
+Here is an incomplete list of clients and libraries that are known to support GGUF:
+
+* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. 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.
+* [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
+* [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
+* [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
+* [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
+* [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.
+* [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.
+
+## Compatibility
+
+- JAIS models are supported as of llama.cpp release [b3282](https://github.com/ggerganov/llama.cpp/releases/tag/b3282). However, only F16 and Q8_0 quantization were uploaded to this repository. Files of the other quantization methods will be uploaded as soon as they are supported.