joblib

joblib のホームページとユーザー ドキュメントは、次の場所にあります。

https://joblib.readthedocs.io

最新のコードの取得

git を使用して最新のコードを取得するには、次のように入力します。

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

git がインストールされていない場合は、最新のコードの zip をダウンロードできます: https://github.com/joblib/joblib/archive/refs/heads/main.zip

インストール中

pip を使用して joblib をインストールできます。

 pip インストール joblib

任意のディレクトリから、または:

 Python setup.py インストール

ソースディレクトリから。

依存関係

• Joblib には、Python 以外に必須の依存関係はありません (サポートされているバージョンは 3.8 以降)。
• Joblib には、配列操作のために Numpy (少なくともバージョン 1.6.1) へのオプションの依存関係があります。
• Joblib には、プロセス管理用に独自にベンダー提供された loky のコピーが含まれています。
• Joblib は numpy 配列を効率的にダンプおよびロードできますが、numpy をインストールする必要はありません。
• Joblib には、圧縮シリアル化のための zlib および gzip のより高速な代替手段として、オプションで python-lz4 への依存関係があります。
• Joblib には、並列ワーカー プロセスでのメモリ リークを軽減するための psutil へのオプションの依存関係があります。
• 一部の例では、パンダなどの外部依存関係が必要です。詳細については、「ドキュメントの構築」セクションの手順を参照してください。

貢献するためのワークフロー

joblib に貢献するには、まず github でアカウントを作成します。これが完了したら、joblib リポジトリをフォークして独自のリポジトリを作成し、作業するコンピュータ上で「git clone」を使用してクローンを作成します。クローンに変更を加え、github アカウントにプッシュし、複数のコンピューターでテストし、問題がなければメイン リポジトリにプル リクエストを送信します。

テストスイートの実行

テスト スイートを実行するには、pytest (バージョン >= 3) とカバレッジ モジュールが必要です。以下を使用してテスト スイートを実行します。

 pytestジョブライブラリ

プロジェクトのルートから。

ドキュメントの構築

ドキュメントをビルドするには、sphinx (>=1.4) といくつかの依存関係がインストールされている必要があります。

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

次に、次のコマンドを使用してドキュメントを構築できます。

ドキュメントを作成する

HTML ドキュメントはdoc/_build/htmlディレクトリにあります。

ソース tarball の作成

パッケージ化や配布などのためにソース tarball を作成するには、次のコマンドを実行します。

 Python setup.py sdist

tarball は dist ディレクトリに作成されます。このコマンドはドキュメントをコンパイルし、結果の tarball は Python 標準ライブラリ以外の追加の依存関係なしでインストールできます。 setuptool と sphinx が必要になります。

リリースを作成して PyPI にアップロードする

このコマンドは、リリースを作成して PyPI にアップロードするためにプロジェクト マネージャーのみが実行します。

 Python setup.py sdist bdist_wheel
麻紐アップロード dist/*

ドキュメントは git プッシュごとに自動的に更新されることに注意してください。そうでない場合は、ドキュメントをローカルでビルドしてみて、ドキュメントのビルド エラー (特にサンプルの実行時) を解決してください。

変更ログの更新

変更は CHANGES.rst ファイルにリストされます。これらは手動で更新する必要がありますが、次の git コマンドを使用して行を生成できます。

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