Crie o ambiente de desenvolvimento.

Antes de realizar qualquer modificação no código, é fundamental estabelecer o ambiente necessário para o desenvolvimento do Xinference. Isso inclui familiarizar-se com o uso do Git, criar um ambiente isolado, instalar o Xinference e compilar a parte do frontend.

Uso do Git

Quando você precisa corrigir um problema, adicionar uma melhoria ou aprimorar a documentação, é importante estar familiarizado com o GitHub e o repositório do Xinference.

Para novos usuários, usar Git é um dos aspectos mais intimidantes de participar do desenvolvimento do Xinference. É fácil ficar sobrecarregado rapidamente, mas o guia abaixo ajudará a simplificar o processo e reduzir possíveis problemas. Se você encontrar dificuldades que não consegue resolver, sinta-se à vontade para buscar ajuda na comunidade.

O código do Xinference está hospedado no GitHub. Para contribuir com o código do Xinference, você precisa registrar uma conta gratuita no GitHub. Utilizamos Git para controle de versão, permitindo que todos participem do desenvolvimento do projeto.

Você pode consultar o Guia do GitHub para instalar o git, configurar chaves SSH e configurar o git. Você precisa concluir essas etapas para garantir que seu repositório local e o GitHub funcionem corretamente, permitindo que o trabalho subsequente prossiga sem problemas.

Aqui estão alguns bons recursos para aprender Git:

• Documentação Oficial do Git

• Livro Pro Git

• Tutorial de Git da Atlassian

• Git - Guia Conciso

Nota

Se durante o git clone o código estiver lento, você pode adicionar um proxy com o seguinte comando.

export https_proxy=YourProxyAddress

Criar um ambiente isolado

Antes da instalação oficial do Xinference, recomenda-se usar o Conda para criar um ambiente isolado, facilitando as operações futuras.

conda create --name xinf
conda activate xinf

xinf pode ser substituído pelo nome personalizado do ambiente Conda.

Em seguida, é necessário instalar o Python e o Node.js (npm) no ambiente Conda recém-criado. O comando é:

conda install python=3.12
conda install nodejs

A partir da instalação a partir do código-fonte

Antes de começar, certifique-se de que você clonou o repositório. Supondo que você clonou o repositório em um diretório chamado inference, entre nesse diretório, que contém os arquivos setup.cfg e setup.py, e execute o seguinte comando:

pip install -e .
xinference-local

Se o comando for executado com sucesso, você poderá usar o Xinference normalmente. Para mais detalhes sobre o tutorial de uso, consulte Uso.

Se ocorrer um erro ou travar durante a execução, será necessário realizar a próxima etapa de compilação do frontend.

Compilação front-end

Primeiro, é necessário entrar no diretório inference/xinference/ui/web/ui e, em seguida, executar o seguinte comando para limpar o cache:

npm cache clean

Se a execução do comando falhar, você pode tentar adicionar a opção --force.

Nota

Se o diretório já contiver a pasta node_modules, é recomendável excluí-la manualmente primeiro.

Em seguida, execute o seguinte comando nesse diretório para compilar o front-end:

npm install
npm run build

Se o primeiro comando falhar, você ainda pode tentar resolver adicionando a opção --force.

Depois de compilar o front-end, você pode retornar ao diretório que contém os arquivos setup.cfg e setup.py e, em seguida, instalar o Xinference usando pip install -e ..