RunPod API および SDK の公式 Python ライブラリへようこそ。
目次
|インストール
サーバーレス ワーカー (SDK)
クイックスタート
地元のテスト担当者
API言語ライブラリ(GraphQLラッパー)
エンドポイント
GPU クラウド (ポッド)
ディレクトリ
コミュニティと貢献
# 最新のリリース バージョンをインストールしますpip install runpod# または# 最新の開発バージョン (メイン ブランチ) をインストールしますpip install git+https://github.com/runpod/runpod-python.git
このパッケージの最新バージョンを使用するには、Python 3.8 以降が必要です。
この Python パッケージは、カスタム エンドポイント API として RunPod にデプロイできるサーバーレス ワーカーの作成にも使用できます。
モデル定義と RunPod ワーカー開始コードを含む Python スクリプトをプロジェクト内に作成します。この Python コードをデフォルトのコンテナー開始コマンドとして実行します。
# my_worker.pyimport runpoddef is_even(job):job_input = job["input"]the_number = job_input["number"]if not isinstance(the_number, int):return {"error": "愚かな人間よ、あなたはinteger."}if the_number % 2 == 0:return Truereturn Falserunpod.serverless.start({"handler":は_偶数})
コンテナーの起動時にこのファイルが実行されるようにしてください。これは、runpod.io/console/serverless/user/templates でテンプレートを設定するときに docker コマンドで呼び出すか、Dockerfile でデフォルトのコマンドとして設定することによって実現できます。
基本的なサーバーレス API の作成についてはブログ投稿を参照するか、詳細については詳細ドキュメントを参照してください。
RunPod にデプロイする前に、ワーカーをローカルでテストすることもできます。これはデバッグやテストに役立ちます。
python my_worker.py --rp_serve_api
RunPod API を操作する場合、このライブラリを使用して API にリクエストを行うことができます。
import runpodrunpod.api_key = "your_runpod_api_key_found_under_settings"
run
またはrun_sync
メソッドを介して RunPod エンドポイントと対話できます。
endpoint = runpod.Endpoint("ENDPOINT_ID")run_request = endpoint.run( {"モデルの入力キー": "モデルの入力値"} )# エンドポイント実行のステータスを確認します requestprint(run_request.status())# エンドポイント実行リクエストの出力を取得し、エンドポイント実行が完了するまでブロックします。print(run_request.output())
エンドポイント = runpod.Endpoint("ENDPOINT_ID")run_request = endpoint.run_sync( {"モデルの入力キー": "モデルの入力値"} )# 90 秒以内に完了した場合はジョブの結果を返し、それ以外の場合はジョブのステータスを返します。print(run_request )
import runpodrunpod.api_key = "your_runpod_api_key_found_under_settings"# すべての podspod を取得します = runpod.get_pods()# 特定の podpod を取得します = runpod.get_pod(pod.id)# podpod を作成します = runpod.create_pod("test", "runpod/stack "、"NVIDIA GeForce RTX 3070")# を停止しますpodrunpod.stop_pod(pod.id)# podrunpod.resume_pod(pod.id)# を再開します。 podrunpod.terminate_pod(pod.id) を終了します。
. §── docs # ドキュメント §── サンプル # 例 §── runpod # パッケージ ソース コード│ §── api_wrapper # 言語ライブラリ - API (GraphQL)│ §── cli # コマンド ライン インターフェイス関数│ §── エンドポイント #言語ライブラリ - エンドポイント│ └── サーバーレス # SDK - サーバーレスワーカー └── テスト # パッケージテスト
プル リクエストと GitHub の問題の両方を歓迎します。バグ修正と新機能は奨励されていますが、最初に私たちの貢献ガイドをお読みください。