Initial commit

LICENSE

@@ -0,0 +1,70 @@
+The CodeGeeX4 License
+
+1. 定义
+
+“许可方”是指分发其软件的 CodeGeeX 团队。
+“软件”是指根据本许可提供的 CodeGeeX4 模型参数。
+
+2. 许可授予
+
+根据本许可的条款和条件，许可方特此授予您非排他性、全球性、不可转让、不可再许可、可撤销、免版税的版权许可。
+本许可允许您免费使用本仓库中的所有开源模型进行学术研究，对于希望将模型用于商业目的的用户，需在[这里](https://open.bigmodel.cn/mla/form)完成登记。经过登记的用户可以免费使用本模型进行商业活动，但必须遵守本许可的所有条款和条件。
+上述版权声明和本许可声明应包含在本软件的所有副本或重要部分中。
+如果您分发或提供 THUDM / 智谱AI 关于 CodeGeeX4 开源模型的材料（或其任何衍生作品），或使用其中任何材料（包括 CodeGeeX4 系列的所有开源模型）的产品或服务，您应:
+
+(A) 随任何此类 THUDM / 智谱AI 材料提供本协议的副本；
+(B) 在相关网站、用户界面、博客文章、关于页面或产品文档上突出显示 “Built with CodeGeeX4”。
+如果您使用 THUDM / 智谱AI的 CodeGeeX4 开源模型的材料来创建、训练、微调或以其他方式改进已分发或可用的 AI 模型，您还应在任何此类 AI 模型名称的开头添加 “CodeGeeX4”。
+
+3. 限制
+
+您不得出于任何军事或非法目的使用、复制、修改、合并、发布、分发、复制或创建本软件的全部或部分衍生作品。
+您不得利用本软件从事任何危害国家安全和国家统一，危害社会公共利益及公序良俗，侵犯他人商业秘密、知识产权、名誉权、肖像权、财产权等权益的行为。
+您在使用中应遵循使用地所适用的法律法规政策、道德规范等要求。
+
+4. 免责声明
+
+本软件“按原样”提供，不提供任何明示或暗示的保证，包括但不限于对适销性、特定用途的适用性和非侵权性的保证。
+在任何情况下，作者或版权持有人均不对任何索赔、损害或其他责任负责，无论是在合同诉讼、侵权行为还是其他方面，由软件或软件的使用或其他交易引起、由软件引起或与之相关
+软件。
+
+5. 责任限制
+
+除适用法律禁止的范围外，在任何情况下且根据任何法律理论，无论是基于侵权行为、疏忽、合同、责任或其他原因，任何许可方均不对您承担任何直接、间接、特殊、偶然、示范性、
+或间接损害，或任何其他商业损失，即使许可人已被告知此类损害的可能性。
+
+6. 争议解决
+
+本许可受中华人民共和国法律管辖并按其解释。 因本许可引起的或与本许可有关的任何争议应提交北京市海淀区人民法院。
+请注意，许可证可能会更新到更全面的版本。 有关许可和版权的任何问题，请通过 [email protected] 与我们联系。
+1. Definitions
+“Licensor” means the CodeGeeX Team that distributes its Software.
+“Software” means the CodeGeeX4 model parameters made available under this license.
+2. License
+Under the terms and conditions of this license, the Licensor hereby grants you a non-exclusive, worldwide, non-transferable, non-sublicensable, revocable, royalty-free copyright license.
+This license allows you to use all open source models in this repository for free for academic research. For users who wish to use the models for commercial purposes, please do so [here](https://open.bigmodel.cn/mla/form)
+Complete registration. Registered users are free to use this model for commercial activities, but must comply with all terms and conditions of this license.
+The copyright notice and this license notice shall be included in all copies or substantial portions of the Software.
+If you distribute or provide THUDM / Zhipu AI materials on the CodeGeeX4 open source model (or any derivative works thereof), or products or services that use any materials therein (including all open source models of the CodeGeeX4 series), you should:
+(A) Provide a copy of this Agreement with any such THUDM/Zhipu AI Materials;
+(B) Prominently display "Built with CodeGeeX4" on the relevant website, user interface, blog post, related page or product documentation.
+If you use materials from THUDM/Zhipu AI's CodeGeeX4 model to create, train, operate, or otherwise improve assigned or available AI models, you should also add "CodeGeeX4" to the beginning of any such AI model name.
+3. Restrictions
+You are not allowed to use, copy, modify, merge, publish, distribute, copy or create all or part of the derivative works of this software for any military or illegal purposes.
+You are not allowed to use this software to engage in any behavior that endangers national security and unity, endangers social public interests and public order, infringes on the rights and interests of others such as trade secrets, intellectual property rights, reputation rights, portrait rights, and property rights.
+You should comply with the applicable laws, regulations, policies, ethical standards, and other requirements in the place of use during use.
+4. Disclaimer
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+5. Limitation of Liability
+EXCEPT TO THE EXTENT PROHIBITED BY APPLICABLE LAW, IN NO EVENT AND UNDER NO LEGAL THEORY, WHETHER BASED IN TORT,
+NEGLIGENCE, CONTRACT, LIABILITY, OR OTHERWISE WILL ANY LICENSOR BE LIABLE TO YOU FOR ANY DIRECT, INDIRECT, SPECIAL,
+INCIDENTAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES, OR ANY OTHER COMMERCIAL LOSSES, EVEN IF THE LICENSOR HAS BEEN ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGES.
+6. Dispute Resolution
+This license shall be governed and construed in accordance with the laws of People’s Republic of China. Any dispute
+arising from or in connection with this License shall be submitted to Haidian District People's Court in Beijing.
+Note that the license is subject to update to a more comprehensive version. For any questions related to the license and
+copyright, please contact us at [email protected].

README.md

@@ -1,5 +1,80 @@
 ---
 license: other
 license_name: codegeex4
-license_link: LICENSE
+license_link: https://huggingface.co/THUDM/codegeex4-all-9b-GGUF/blob/main/LICENSE
+language:
+- zh
+- en
+tags:
+- glm
+- codegeex
+- thudm
+inference: false
+pipeline_tag: text-generation
 ---
+
+# CodeGeeX4: Open Multilingual Code Generation Model
+
+[中文](./README_zh.md)
+
+[GitHub](https://github.com/THUDM/CodeGeeX4)
+
+!!! This is the GGUF version of CodeGeeX4, the original version can be found [here](https://huggingface.co/THUDM/codegeex4-all-9b). !!!
+
+We introduce CodeGeeX4-ALL-9B, the open-source version of the latest CodeGeeX4 model series. It is a multilingual code generation model continually trained on the [GLM-4-9B](https://github.com/THUDM/GLM-4), significantly enhancing its code generation capabilities. Using a single CodeGeeX4-ALL-9B model, it can support comprehensive functions such as code completion and generation, code interpreter, web search, function call, repository-level code Q&A, covering various scenarios of software development. CodeGeeX4-ALL-9B has achieved highly competitive performance  on public benchmarks, such as [BigCodeBench](https://huggingface.co/datasets/bigcode/bigcodebench) and [NaturalCodeBench](https://github.com/THUDM/NaturalCodeBench). It is currently the most powerful code generation model with less than 10B parameters, even surpassing much larger general-purpose models, achieving the best balance in terms of inference speed and model performance.
+
+## Get Started
+
+Download model weights:
+```
+huggingface-cli download THUDM/codegeex4-all-9b-GGUF 
+```
+
+Use the latest llama.cpp to launch codegeex4-all-9b-GGUF
+```
+git clone https://github.com/ggerganov/llama.cpp.git
+cd llama.cpp
+cmake . -B build
+cmake --build build --config Release
+build/bin/llama-cli -m Your_Model_Path -p "Your_Input"
+```
+
+Please make sure the prompt is under the following format:
+```
+f"<|system|>\n{system_prompt}\n<|user|>\n{prompt}\n<|assistant|>\n"
+```
+Default system_prompt:
+```
+你是一位智能编程助手，你叫CodeGeeX。你会为用户回答关于编程、代码、计算机方面的任何问题，并提供格式规范、可以执行、准确安全的代码，并在必要时提供详细的解释。
+```
+The English version:
+```
+You are an intelligent programming assistant named CodeGeeX. You will answer any questions users have about programming, coding, and computers, and provide code that is formatted correctly.
+```
+
+## Evaluation
+
+| **Model**                   | **Seq Length** | **HumanEval** | **MBPP** | **NCB** | **LCB** | **HumanEvalFIM** | **CRUXEval-O** |
+|-----------------------------|----------------|---------------|----------|---------|---------|------------------|----------------|
+| Llama3-70B-intruct          | 8K             | 77.4          | 82.3     | 37.0    | 27.4    | -                | -              |
+| DeepSeek Coder 33B Instruct | 16K            | 81.1          | 80.4     | 39.3    | 29.3    | 78.2             | 49.9           |
+| Codestral-22B               | 32K            | 81.1          | 78.2     | 46.0    | 35.3    | 91.6             | 51.3           |
+| CodeGeeX4-All-9B            | 128K           | 82.3          | 75.7     | 40.4    | 28.5    | 85.0             | 47.1           |
+
+## License
+
+The model weights are licensed under the following [License](./LICENSE).
+
+## Citation
+
+If you find our work helpful, please feel free to cite the following paper:
+
+```
+@inproceedings{zheng2023codegeex,
+  title={CodeGeeX: A Pre-Trained Model for Code Generation with Multilingual Benchmarking on HumanEval-X},
+  author={Qinkai Zheng and Xiao Xia and Xu Zou and Yuxiao Dong and Shan Wang and Yufei Xue and Zihan Wang and Lei Shen and Andi Wang and Yang Li and Teng Su and Zhilin Yang and Jie Tang},
+  booktitle={Proceedings of the 29th ACM SIGKDD Conference on Knowledge Discovery and Data Mining},
+  pages={5673--5684},
+  year={2023}
+}
+```

README_zh.md

@@ -0,0 +1,61 @@
+# CodeGeeX4: 开源多语言代码生成模型
+
+[CodeGeeX4 GitHub](https://github.com/THUDM/CodeGeeX4)
+
+!!! 本仓库为 CodeGeeX4 权重的GGUF版本, 原始版本请见[链接](https://huggingface.co/THUDM/codegeex4-all-9b). !!!
+
+我们推出了 CodeGeeX4-ALL-9B，这是最新的 CodeGeeX4 系列模型的开源版本。该模型是在 [GLM-4-9B](https://github.com/THUDM/GLM-4) 基础上持续训练的多语言代码生成模型，显著提升了代码生成能力。使用单个 CodeGeeX4-ALL-9B 模型，可以支持代码补全与生成、代码解释、联网搜索、函数调用、仓库级代码问答等多种功能，覆盖了软件开发的各个场景。CodeGeeX4-ALL-9B 在 [BigCodeBench](https://huggingface.co/datasets/bigcode/bigcodebench) 和 [NaturalCodeBench](https://github.com/THUDM/NaturalCodeBench) 等公开基准测试中取得了极具竞争力的表现。它是目前参数量少于 100 亿的最强代码生成模型，甚至超越了更大的通用模型，在推理速度和模型性能方面达到了最佳平衡。
+
+
+## 快速开始
+
+下载模型权重:
+```
+huggingface-cli download THUDM/codegeex4-all-9b-GGUF 
+```
+
+使用最新版本的 llama.cpp 运行 codegeex4-all-9b-GGUF
+```
+git clone https://github.com/ggerganov/llama.cpp.git
+cd llama.cpp
+cmake . -B build
+cmake --build build --config Release
+build/bin/llama-cli -m Your_Model_Path -p "Your_Input"
+```
+
+确保输入符合以下格式:
+```
+f"<|system|>\n{system_prompt}\n<|user|>\n{prompt}\n<|assistant|>\n"
+```
+默认 system_prompt:
+```
+你是一位智能编程助手，你叫CodeGeeX。你会为用户回答关于编程、代码、计算机方面的任何问题，并提供格式规范、可以执行、准确安全的代码，并在必要时提供详细的解释。
+```
+
+## 评测指标
+
+| **模型**                   | **序列长度** | **HumanEval** | **MBPP** | **NCB** | **LCB** | **HumanEvalFIM** | **CRUXEval-O** |
+|-----------------------------|----------------|---------------|----------|---------|---------|------------------|----------------|
+| Llama3-70B-intruct          | 8K             | 77.4          | 82.3     | 37.0    | 27.4    | -                | -              |
+| DeepSeek Coder 33B Instruct | 16K            | 81.1          | 80.4     | 39.3    | 29.3    | 78.2             | 49.9           |
+| Codestral-22B               | 32K            | 81.1          | 78.2     | 46.0    | 35.3    | 91.6             | 51.3           |
+| CodeGeeX4-All-9B            | 128K           | 82.3          | 75.7     | 40.4    | 28.5    | 85.0             | 47.1           |
+
+## License
+
+CodeGeeX4-ALL-9B 模型的权重的使用则需要遵循 [License](./LICENSE).
+
+
+## 引用
+
+如果您觉得我们的工作对您有帮助，欢迎引用以下论文：
+
+```
+@inproceedings{zheng2023codegeex,
+  title={CodeGeeX: A Pre-Trained Model for Code Generation with Multilingual Benchmarking on HumanEval-X},
+  author={Qinkai Zheng and Xiao Xia and Xu Zou and Yuxiao Dong and Shan Wang and Yufei Xue and Zihan Wang and Lei Shen and Andi Wang and Yang Li and Teng Su and Zhilin Yang and Jie Tang},
+  booktitle={Proceedings of the 29th ACM SIGKDD Conference on Knowledge Discovery and Data Mining},
+  pages={5673--5684},
+  year={2023}
+}
+```