joblib

A página inicial do joblib com a documentação do usuário está localizada em:

https://joblib.readthedocs.io

Obtendo o código mais recente

Para obter o código mais recente usando git, basta digitar:

 clone do git https://github.com/joblib/joblib.git

Se você não tiver o git instalado, poderá baixar um zip do código mais recente: https://github.com/joblib/joblib/archive/refs/heads/main.zip

Instalando

Você pode usar o pip para instalar o joblib:

 pip instalar joblib

de qualquer diretório ou:

 instalação do python setup.py

do diretório de origem.

Dependências

• Joblib não tem dependências obrigatórias além do Python (as versões suportadas são 3.8+).
• Joblib tem uma dependência opcional do Numpy (pelo menos versão 1.6.1) para manipulação de array.
• Joblib inclui sua própria cópia vendida do loky para gerenciamento de processos.
• Joblib pode despejar e carregar matrizes numpy com eficiência, mas não requer a instalação de numpy.
• Joblib tem uma dependência opcional de python-lz4 como uma alternativa mais rápida ao zlib e gzip para serialização compactada.
• Joblib tem uma dependência opcional de psutil para mitigar vazamentos de memória em processos de trabalho paralelos.
• Alguns exemplos requerem dependências externas, como pandas. Consulte as instruções na seção Construindo a documentação para obter detalhes.

Fluxo de trabalho para contribuir

Para contribuir com o joblib, primeiro crie uma conta no github. Feito isso, bifurque o repositório joblib para ter seu próprio repositório, clone-o usando 'git clone' nos computadores onde deseja trabalhar. Faça suas alterações em seu clone, envie-as para sua conta do github, teste-as em vários computadores e, quando estiver satisfeito com elas, envie uma solicitação pull para o repositório principal.

Executando o conjunto de testes

Para executar o conjunto de testes, você precisa do pytest (versão >= 3) e dos módulos de cobertura. Execute o conjunto de testes usando:

 pytest joblib

da raiz do projeto.

Construindo os documentos

Para construir os documentos você precisa ter o sphinx (>=1.4) e algumas dependências instaladas:

 pip install -U -r .readthedocs-requirements.txt

Os documentos podem então ser criados com o seguinte comando:

 fazer documento

Os documentos HTML estão localizados no diretório doc/_build/html .

Fazendo um tarball de origem

Para criar um tarball de origem, por exemplo, para empacotamento ou distribuição, execute o seguinte comando:

 python setup.py sdist

O tarball será criado no diretório dist. Este comando irá compilar os documentos, e o tarball resultante pode ser instalado sem dependências extras além da biblioteca padrão do Python. Você precisará do setuptool e do esfinge.

Fazendo um lançamento e enviando-o para o PyPI

Este comando é executado apenas pelo gerente de projeto, para fazer um lançamento e fazer upload para o PyPI:

 python setup.py sdist bdist_wheel
fio upload dist/*

Observe que a documentação deve ser atualizada automaticamente a cada git push. Se esse não for o caso, tente construir o documento localmente e resolva qualquer erro de construção do documento (em particular ao executar os exemplos).

Atualizando o changelog

As alterações estão listadas no arquivo CHANGES.rst. Eles devem ser atualizados manualmente, mas o seguinte comando git pode ser usado para gerar as linhas:

 git log --abbrev-commit --date=short --no-merges --sparse