Bitsandbytes 文档
贡献指南
加入 Hugging Face 社区
并获得增强的文档体验
开始使用
贡献指南
设置
设置 pre-commit 钩子
- 使用
pip install pre-commit安装 pre-commit 钩子。 - 运行一次
pre-commit install来安装钩子，这样它们将在每次提交时运行。 - 如果钩子引入了更改，可以通过
git diff查看。检查这些更改，如果一切正常，使用git add添加它们，然后重新执行之前的提交，此时应该会通过。 - 如果想手动触发钩子，可以运行
pre-commit run --all-files
现在，当你尝试提交时，所有 pre-commit 钩子都会自动运行，如果它们引入了一些更改，你需要重新添加已更改的文件才能提交和推送。
忽略格式化修订
- 运行
git config blame.ignoreRevsFile .git-blame-ignore-revs。这将使git blame能够识别那些仅与格式化相关的提交记录。
文档字符串语法
我们遵循 NumPy 文档字符串约定，唯一显著的区别是我们在文档字符串中使用 Markdown 而不是富文本格式（RTF）进行标记。
请参阅现有文档以了解如何生成自动文档。
文档
- 文档语法指南
- 图片应通过 PR 上传到
bitsandbytes/目录 这里 - 在发布到 PR 的链接中找到每个 PR 的文档构建，例如 https://moon-ci-docs.huggingface.co/docs/bitsandbytes/pr_1012/en/introduction