在进行任何代码修改之前，建立起适用于 Xinference 开发的必要环境至关重要。包括熟悉 Git 的使用、建立一个独立的环境、安装 Xinference 以及前端部分的编译。
当你有一个需要修复的问题、需要添加的增强功能或需要改进的文档时，熟悉 GitHub 和 Xinference 代码库很重要。
对新用户来说，使用 Git 是参与 Xinference 开发最令人畏惧的方面之一。很快就会感到压力山大，但以下指南将有助于简化流程并减少潜在问题。如果您遇到难以解决的问题，欢迎在社区寻求帮助。
Xinference 的代码托管在
GitHub
。要参与 Xinference 代码贡献，你需要注册一个
免费的 GitHub 账户
。我们使用
Git
进行版本控制，以便大家共同参与项目的开发。
你可以参考
GitHub 指南
来安装 git，设置 SSH 密钥以及配置 git。你需要完成这些步骤以确保你的本地仓库和 GitHub 可以正常工作，后续的工作才可以顺利进行。
以下是一些很好的学习 Git 的资源：
Git 官方文档
Pro Git 书籍
Atlassian 提供的 Git 教程
Git-简明指南
如果在
git
clone
代码的时候速度较慢，可以通过如下命令添加代理
export https_proxy=YourProxyAddress
在正式安装Xinference之前，建议使用 Conda 创建一个隔离环境方便后续操作。
conda create --name xinf
conda activate xinf
xinf 可替换为自定义的 Conda 环境名。
随后需要在新建的 Conda 环境中安装 Python 以及 Node.js (npm)。命令如下：
conda install python=3.10
conda install nodejs
在开始之前，请确保您已经克隆了存储库。假设您将存储库克隆到名为 inference 的目录中，请进入该目录，其中包含 setup.cfg 和 setup.py 文件，并执行以下命令：
pip install -e .
xinference-local
如果命令能够成功运行，接下来就能正常使用 Xinference 了，使用教程详情见 使用。
如果出现报错或者在运行过程中卡死，那就需要进行下一步前端编译。
首先需要进入 inference/xinference/web/ui 目录下，随后执行如下命令清除缓存：
npm cache clean
如果命令执行失败，您可以尝试添加 --force 选项
如果该目录下已经存在 node_modules 文件夹的话建议先手动删除该文件夹
接着在该目录下执行以下命令进行前端编译：
npm install
npm run build
如果第一个命令执行失败，您仍然可以尝试通过添加 --force 选项解决
编译完前端后，您可以返回到包含 setup.cfg 和 setup.py 文件的目录，然后通过 pip install -e . 安装 Xinference。
