> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/reference/ja/purattofmu/python-sdk.md).

# Python SDK

Roboflow Python SDK は Roboflow REST API をラップしたもので、Python コードから Roboflow とやり取りするための抽象的なメソッドを提供します。

Python SDK では、プロジェクトやワークスペースの管理、データセットのアップロードとダウンロード、モデルでの推論の実行、モデル重みのアップロードなどができます。

Python SDK のメソッドの使用例とリファレンスは、API リファレンス ドキュメントに記載されています。

## リソース

* [インストール](https://github.com/roboflow/roboflow-python#-installation) (GitHub)
* [クイックスタート](https://github.com/roboflow/roboflow-python#quickstart) (GitHub)
* [Roboflow Python GitHub](https://github.com/roboflow/roboflow-python)
* [Roboflow Python リファレンス](https://roboflow.github.io/roboflow-python/)

## インストール

Roboflow Python パッケージには以下が必要です `Python >=3.10`.

```bash
pip install roboflow
```

### 軽量パッケージ

必要なのが [Vision Events SDK](https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events#python-sdk) で、重い画像処理依存関係（OpenCV、NumPy、Pillow）なしで CLI も必要なだけなら、代わりに軽量版をインストールしてください：

```bash
pip install roboflow-slim
```

この `roboflow-slim` パッケージは、完全版の `roboflow` パッケージよりもかなり小さく、NumPy、OpenCV、Matplotlib、Pillow を含みません。ビジョンイベントのロギングや基本的な CLI 操作だけが必要なエッジデバイス、サーバーレス環境、CI/CD パイプライン、マイクロサービスに適しています。

両方のパッケージは同じコードベースと API を共有しています。 `roboflow-slim` は完全版の `roboflow` でも同様に動作します。画像の可視化が不要な場合は、軽量な依存関係を採用してください。

## 最初のスクリプト

API キーを取得してください： [設定 → API キー](https://app.roboflow.com/settings/api) そして、次のようにエクスポートします：

```bash
export ROBOFLOW_API_KEY=rf_xxxxx
```

次に、公開されている Universe データセットのバージョンをダウンロードします：

```python
import roboflow

rf = roboflow.Roboflow()  # picks up ROBOFLOW_API_KEY
project = rf.workspace("roboflow-100").project("poker-cards-cxcvz")
version = project.version(1)

version.download("yolov8")
```

参照 [Python SDK で認証する](/reference/ja/purattofmu/python-sdk/authenticate-with-the-python-sdk.md) キーを渡す他の 2 つの方法については、こちらをご覧ください。推論を実行するには、 [ワークフロー](https://docs.roboflow.com/workflows) または [REST API](/reference/ja/purattofmu/rest-api.md) - SDK の推論は非推奨です。

## クイックリファレンス

SDK の主要なオブジェクト：

| クラス               | 表すもの              | 主なメソッド                                                                                                     |
| ----------------- | ----------------- | ---------------------------------------------------------------------------------------------------------- |
| `Roboflow`        | トップレベルのクライアント     | `workspace()`, `project()`                                                                                 |
| `ワークスペース`         | Roboflow のワークスペース | `list_projects()`, `create_project()`, `upload_dataset()`, `list_workflows()`, `list_folders()`, `trash()` |
| `プロジェクト`          | データセット/プロジェクト     | `versions()`, `version(n)`, `upload()`, `train()`, `delete()`, `restore()`                                 |
| `バージョン`           | 固定されたデータセットのバージョン | `download()`, `train()`, `model`, `delete()`, `restore()`                                                  |
| `*.Model` (タスクごと) | ホストされた学習済みモデル     | `predict()`                                                                                                |

各公開メソッドのタスク別ガイドは、サイドバーのこのセクションの残りを参照してください。

### Microsoft Visual C++ の手順

Microsoft Visual C++ 再頒布可能パッケージは、一部の Python パッケージで必要です。Microsoft の公式 वेबसाइटからダウンロードできます：

x64 システムの場合： <https://aka.ms/vs/16/release/vc_redist.x64.exe>

x86 システムの場合： <https://aka.ms/vs/16/release/vc_redist.x86.exe>

適切なファイルをダウンロードしたら、インストーラーを実行し、画面の指示に従って再頒布可能パッケージをインストールしてください。
