platform-cli について
`ul cloud`コマンドラインからUltralytics Platformを操作するスキルです。クラウド上のデータセット、モデル、トレーニング、デプロイを管理するユーザー向けに、コマンド構文やワークフロー、変更確認、非同期ジョブの扱いを説明します。
主な機能
- 01`ul cloud`によるプラットフォームリソース管理
- 02データセット、プロジェクト、モデルの一覧・作成・複製・更新
- 03クラウドトレーニングの開始と監視
- 04モデルのエクスポートとデプロイ管理
- 05アカウント使用量、推論、データインポートの確認
活用シーン
- 01トレーニング前のデータセット検索と準備状況確認
- 02クラウドトレーニングの開始と状態監視
- 03モデルの重み取得またはエクスポート作成
- 04モデルのデプロイとエンドポイントの健全性確認
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ ultralytics/ skills --skill platform-cliインストール後、Claude Code で/platform-cliを入力して読み込まれたか確認します。
同梱ファイルagents/openai.yaml
詳細
プラットフォーム CLI(ul cloud)
ul の実行には Python 3.11 以降が必要で、pip install ultralytics または pip install ultralytics-platform でインストールできます。ul cloud <resource> <operation> は、生成された SDK を介して Platform API を呼び出します。ul login、ul train、ul predict、ul cloud train|predict|export|download のショートカット(yolo を参照)、その他のローカルコマンドは、ultralytics パッケージに処理を委譲します。このスキルでは Platform の操作を扱い、モデル選択やハイパーパラメーターの調整は扱いません。
pip install ultralytics # or `pip install ultralytics-platform`
export ULTRALYTICS_API_KEY="YOUR_API_KEY" # or `ul login API_KEY`
ul cloud --help # every resource and operation
ul cloud training start --help # one operation's arguments, types, and choices
標準的なコマンド形式
ul cloud account summary # plan, credits, counts; `username` is your workspace
ul cloud datasets list # omit owner= for your own workspace; owner=TEAM for a team
ul cloud projects create project=helmets name="Helmet Detection" visibility=private
ul cloud models create body='{"owner":"WS","project":"helmets","model":"exp1","name":"Experiment 1"}'
ul cloud training start model_id=MODEL_ID gpu_type=l4 \
train_args='{"model":"yolo26n.pt","data":"ul://WS/datasets/helmets","epochs":50}'
ul cloud models training project=helmets model=exp1 # live status, epoch progress, metrics
ul cloud models files project=helmets model=exp1 # short-lived weights download URL
引数のルール:
- 事前に
--helpを呼び出さず、ここに示すコマンド形式を使用します。必要な引数がない場合、または引数エラーが発生した場合は、操作のヘルプを確認してください。 - 引数には、
key=value(gpu_type、project_idなど)の形式で SDK の Python 名を指定します。--key valueの形式は使用しません。値を指定せずにブール値のキーを指定した場合は、trueを意味します。JSON はシェル用に引用符で囲みます。 - ヘルプに
body (dict[str, Any])と記載されている操作では、body=の JSON オブジェクトをちょうど 1 つ指定します。これらは、API リクエストが複数の形式のいずれかになる操作です:models create、deployments update、images update、lifecycle delete-trash、datasets ingest、datasets create-batch、upload signed-url、storage-integrations create/discover、models predict/deployments predict。それ以外の操作では、フラットなフィールドを指定します。train_args、metadata、argsなどのネストされたオブジェクトも JSON 値として指定します。 - オブジェクトと配列の値には、
@file.jsonまたは標準入力用の@-を使用できます。predict のfileフィールドなど、マルチパートのバイナリには@pathのみ使用できます。 - body のキーと値の型は推測したり、ファイル全体を読み込んだりせず、本番環境のコントラクト
https://platform.ultralytics.com/openapi.jsonにある操作のリクエストスキーマ(例:paths["/api/models"].post.requestBody)のみを参照してください。
動作のルール:
- 出力は API レスポンス全体で、コンテンツタイプに応じて JSON、テキスト、またはバイト列として標準出力に出力されます。ダウンロード操作が返すのは、有効期限付きの署名付き URL であり、バイト列ではありません:
datasets export、datasets create-export、models files、完了したexports retrieve。これらの URL はそのまま保持し、別途取得してください。 - エラーは標準エラー出力に送られます。終了コードは、API/接続エラーが 1、引数/ファイルエラーが 2、中断時が 130 です。中断しても送信済みのジョブはキャンセルされません。対応するキャンセル操作(
models delete-training、exports delete、datasets delete-batch)を使用してください。 --json、--fields、--dry-run、自動ページネーションはありません。datasets list(limit、include_samples、include_image_urls)とprojects list(limit)は、offsetやsearchを受け付けません。データセット一覧を小さく保つには、include_samples=falseを指定してください。models listではproject=が必須です。ページネーションを行う操作では、page、offset、cursor、page_tokenのいずれかが公開されています。返された続行フィールドを使い、結果がなくなるまで取得してください。limitのみを指定した一覧でも、すべての結果が含まれるとは限りません。- パスの
ownerを省略すると、アカウントを一度照会したうえで、ログイン中のユーザー名がデフォルト値になります。チームのワークスペースを使用する場合は、owner=TEAMを指定してください。アカウント、請求、ゴミ箱、ストレージ統合、Roboflow のコマンドは、認証情報に対応するアカウントに対して実行されます。また、API キーではaccount summaryにチームは表示されません。 - 表示名、URL スラッグ、データベース ID、URI はそれぞれ異なります。トレーニングデータは
ul://OWNER/datasets/DATASET、開始時の重みはチェックポイント名またはul://OWNER/PROJECT/MODELです。返された ID とスラッグを次のコマンドに引き継いでください。不足している識別子は、名前や URL から推測せず、取得してください。名前で指定したデータセットやプロジェクトを取得する場合は、まず一覧からスラッグを確認してください。
作業方法
- 求められている結果と対象を特定します。識別子が正確に指定されている場合はそれを使用し、そうでない場合は候補を一覧表示して、曖昧さのないものを1つ選びます。候補が複数ある場合は、違いを示すメタデータを確認し、対象または結果が依然として曖昧であれば質問します。指定されたリソースが見つからない場合は、その旨を伝えて最も近い候補を提示し、別のリソースで代用しないでください。範囲を限定した一覧表示だけでは、存在しないことの証明にはなりません。検索範囲を広げるか、検索した内容を報告してください。ユーザーが自身のワークスペースで名前を挙げたデータセットを検索します。新しい公開データセットを見つけるには、
explore search q=... type=datasetsを使用し、aerial、次にUAVのように、短いキーワードを1つずつ指定してtask=で絞り込みます。Explore のデータセット検索では、まずsort順にトークンの自動補完による名前の一致を一覧表示し、次にコンテンツが検索語句に一致する画像を含むデータセットを表示します。プロジェクト検索では、文字列がそのまま一致するものが検索されます。公開データセットをトレーニング用に推奨する前に、クローン作成の可否、ラベル、分割を確認してください。一致するものがない場合や検索に失敗した場合は、その旨を伝えてください。 - 変更に影響する場合は、現在の状態(公開範囲、ステータス、既存の子要素)を確認します。
- 要求された最小限の変更を実行し、レスポンスで確認します。レスポンスに必要な状態が含まれていない場合、書き込みの成否が不確かな場合、またはジョブが非同期の場合は、再取得します。
- 実際に変更された内容、現在のステータス、警告、および存在する場合は検証済みのリソースリンクを報告します。エントリーの作成、ジョブの受け付け、ジョブの完了は、それぞれ別の結果です。
明確に依頼された操作は、何度も確認を求めずに実行します。支出、共有、取り消せない変更については、まず対象や結果の曖昧さを解消します。助言の依頼は、操作の許可ではありません。「整理して」は、アカウント全体の削除を許可するものではありません。CLI で公開されていない操作を実行したように見せるために、コマンド、フラグ、ステータス編集を捏造しないでください。その場合は、ユーザーに Platform UI を案内してください。
ワークフロー
以下のコマンドでは、ul cloud プレフィックスとデフォルトの owner を省略しています。
| 目的 | コマンド |
|---|---|
| 一覧表示 | projects list、datasets list、models list project=P。explore search q=... type=datasets は公開コンテンツを検索するもので、非公開のインベントリではありません。データセットを取得して、タスク、クラス、分割、準備状況を確認します。 |
| 作成 | projects create project=slug name="Display"、datasets create dataset=slug name="Display" task=detect。visibility= は意図的に設定します。 |
| コピー | datasets clone dataset=D owner_body=DEST_OWNER、projects clone project=P owner_body=DEST_OWNER、models clone project=P model=M owner_body=DEST_OWNER project_body=DEST_PROJECT。パスフィールドにはコピー元を指定し、*_body フィールドにはコピー先を指定します。モデルのコピー先プロジェクトは、あらかじめ存在している必要があります。 |
| 名前変更、編集、移動 | 変更するフィールドのみを指定して <resource> update を実行します。新しい name を指定すると URL のスラッグも変更されるため、その後は返されたスラッグを使用します。models update project=P model=M project_id=DEST_ID では、変更するフィールドとしてこれだけを指定してモデルを移動します。 |
| 実行の比較 | モデルの概要には projects retrieve project=P、models list project=P、またはデータセット上の実行には datasets models dataset=D を使用します。不足しているメトリクスを確認する場合に限り、models retrieve project=P model=M を使用します。リンク付きの表に、ステータス、データセット/バージョン、構成、要求したメトリクスをまとめます。不足しているメトリクスはゼロではなく、不明です。比較コマンドはありません。 |
| モデルの分析 | models retrieve project=P model=M analysis=1 を実行し、必要に応じて models find-similar-training-images project=P model=M を実行します。対象範囲とハッシュの選択については、モデルの分析と類似性を参照してください。 |
| 重み | models files project=P model=M は一時的なチェックポイント URL を返します。トレーニングやエクスポートは必要ありません。 |
| 変換 | exports create project=P model=M format=onnx を実行し、進行状況とダウンロード URL を確認するには exports retrieve project=P model=M export_id=ID を実行します。format=engine には gpu_type が必要です。エクスポートしてもデプロイはされません。 |
| データセットのバージョン | datasets create-export dataset=D は、署名付き NDJSON URL を持つ不変の番号付きスナップショットを保存します。datasets export dataset=D(保存済みバージョンには v=N)はダウンロード URL を返します。datasets restore dataset=D version=N はデータセットを以前の状態に戻します。datasets update-export dataset=D version=N description="TEXT" は保存済みバージョンの説明を更新します。 |
| デプロイ | deployments create project=P model=M deployment=slug name="Display" region=us-central1。deployments update deployment=D body='{"action":"replace","project":"P","model":"M"}' は同じ URL のモデルを入れ替えます。body='{"action":"stop"}' と {"action":"start"} は、それぞれ一時停止と再開を行います。deployments health deployment=D はウォームアップします。 |
| 使用状況、サービス | account storage、billing usage-summary、billing transactions は、認証情報に紐づくアカウント自身の使用状況を確認します。deployments list、retrieve、logs、metrics はエンドポイントを確認します。フィルターとページネーションについては、使用状況と請求およびコンピューティングを参照してください。 |
| 推論 | models predict project=P model=M body='{"file":"@image.jpg"}' または deployments predict deployment=D body='{"file":"@image.jpg"}'。images predict image_id=ID model_id=ul://... は、ラベルを保存せずにデータセットの画像に対して推論します。 |
| エージェント | agents save name="Display" graph='{...}' version=0 はキャンバス上のエージェントを作成します。まず agents save --help を読み、ブロックを確認してください。実在するデータセット、モデル、デプロイ、および検出可能なクラスを使用し、返された errors を修正します。編集するには、agents list id=ID で現在の graph と version を読み取り、完全に編集したグラフを指定して agents save id=ID name=N version=V graph='{...}' を実行します。 |
| データのインポート | datasets create dataset=D name="Display" を実行し、続いて upload signed-url body=(assetType、assetId、filename、contentType、totalBytes)で .zip、.tar、.tar.gz、.tgz、.ndjson のいずれか1つのファイルに対する署名付き URL を取得します。返されたヘッダーを使ってバイトデータを PUT し、datasets ingest dataset=D body='{"sessionId":"S"}' を実行してアップロードを完了します(または {"sourceUrl":...})。準備完了になるまで取得を繰り返します。キューに入った状態は、インポート済みではありません。 |
| ゴミ箱 | projects delete project=P、datasets delete dataset=D、models delete project=P model=M は、それらを30日間のゴミ箱に移動します。lifecycle trash はゴミ箱の内容を一覧表示し、lifecycle restore id=ID type=model は削除を取り消します。lifecycle delete-trash body='{"id":"ID","type":"model"}' は1項目を完全に削除し、body='{"all":true}' はワークスペースのゴミ箱をすべて完全に空にします。 |
クラウドトレーニング
- ワークスペース、プロジェクト、準備済みデータセット、開始時の重み、要求された設定を確認します。
gpu_typeを選ぶ前にtraining gpu-availabilityを確認してください。クラウドトレーニングではクレジットを消費します。dataにはデータセットの実際の所有者を指定する必要があります。モデルの所有者とは異なる場合があります。 - 新しい実験を作成するには、
owner、project、modelスラッグ、nameを指定してmodels create body=...を実行します。開始に失敗した後、保留中のエントリーを再利用する場合は、状態を確認してください。 - 最新の
train_argsにmodel、data、数値のepochs、および要求された設定を含めて、training start model_id=ID gpu_type=... train_args=...を実行します。deviceは省略してください。保存済みのワーカー引数をそのままコピーしないでください。保存されたデータパスはワーカー環境内でのみ有効な場合があります。 - 進捗を確認するには
models trainingまたはmodels retrieveを使用します。完了を待つよう依頼されていない限り、実行へのリンクと実際のステータスを返してください。models delete-trainingは実行をキャンセルしますが、エントリーは保持します。実行がまだアクティブなモデルに対してtraining startを呼び出さないでください。
復旧
- 401:認証情報を漏らさずに、認証情報の取得元を確認します。
ULTRALYTICS_API_KEYは保存済みのログインキーより優先されるため、再度ログインしても古い環境変数の値は置き換わりません。実行環境から認証情報が注入される場合は、その環境の手順を使用してください。その後、読み取り操作で確認します。 - 403:ワークスペースへのアクセス、権限、操作上の制約に関するエラー内容を確認してください。ログインの期限切れだと決めつけないでください。
- 明らかな検証エラーは、要求された操作の範囲内で修正します。タイムアウトが発生した場合や書き込みの成否が不明な場合は、再試行する前に状態を確認してください。入力、権限の問題が解決しない場合や、失敗が繰り返される場合は停止し、書き込みを重複させずに部分的な結果と残作業を報告してください。
リソースリンク
リソースリンクには https://platform.ultralytics.com を使用します。プロジェクトは /{owner}/{project}、データセットは /{owner}/datasets/{dataset}、モデルとトレーニングは /{owner}/{project}/{model}、デプロイは返された deployment スラッグを使って /{owner}/deploy/{deployment} です。ステータスが ready になったら、推論用として deployments retrieve が返す serviceUrl をそのまま報告してください。サービス URL を組み立ててはいけません。
操作上の注意点
各コマンドの機能は操作ヘルプに記載されています。ここでは、ヘルプに記載されていない副作用と制約について説明します。内容が食い違う場合は、--help とエラーメッセージを優先してください。
クローン
- プロジェクト、データセット、モデルのクローン先には、異なるワークスペースを指定する必要があります。同じワークスペース内の実験を作成する方法として、クローンを使うことはできません。
models createを使用してください。 - モデルのソースには使用可能な重みが必要で、トレーニング中であってはなりません。プロジェクトのクローンには、重みを持つ完了済みモデルが含まれますが、データセット、デプロイ、エクスポート、未完了の実行は含まれません。
公開設定
- 作成時に公開がデフォルトで設定される場合や、クローンでソースの公開設定が引き継がれる場合があるため、
visibility=を明示的に指定してください。公開プロジェクトでは、そのモデルも公開されます。公開設定は、コラボレーターに編集権限を付与するものではありません。
更新
- 配列と
metadataオブジェクトは以前の値を置き換えます。変更のない項目も含め、配列またはオブジェクト全体を送信してください。 starredを含む更新では、ほかのすべてのフィールドが無視されます。starredだけを送信してください。- 既存モデルに対して再度トレーニングを開始すると、以前の実行メトリクスと結果が消去されます。それらを保持するには、新しいモデルを作成してください。既存の重みを使ったファインチューニングでは、オプティマイザーやエポック数は引き継がれません。
capture_dataset_version=trueは新しいスナップショットを保存します。既存のスナップショットを選択する設定ではありません。
削除、ゴミ箱への移動、復元
lifecycle delete-trashは取り消せません。指定した項目の完全削除をユーザーが明示的に依頼した場合に限り実行してください。body='{"all":true}'は、ワークスペース内のすべてのゴミ箱を空にするよう明示的に依頼された場合に限り実行してください。それ以外の場合は、ゴミ箱の完全削除は UI からユーザー自身に行ってもらってください。projects update archived=trueは整理のための操作にすぎず、容量は解放されません。- プロジェクトをゴミ箱に移動すると、そのモデルもゴミ箱に移動され、トレーニングはキャンセルされます。
projects deleteとmodels deleteは、ゴミ箱への移動処理中に関連付けられたデプロイを完全に削除します。プロジェクトやモデルを復元しても、デプロイは復元されません。デプロイが関連付けられている場合(lifecycle trash id=ID type=projectまたはtype=modelで確認できます)、その影響を説明し、ユーザーの依頼ですでにデプロイの完全削除が明確に含まれている場合を除き、ゴミ箱に移動する前に明示的な許可を得てください。502 応答はクリーンアップが完了していないことを意味します。デプロイが削除されたと報告する前に、デプロイの状態を確認してください。 - 親を先に復元してください。子が個別にゴミ箱に移動されている場合は、それぞれ復元が必要です。データセットのバージョン復元は別の操作です。
datasets restore dataset=D version=Nは、選択したスナップショットの画像、分割、クラス、アノテーションで現在の内容を置き換えます。現在の状態が先にバージョン化されていない限り、元に戻せません。保持が必要な場合は、最初にdatasets create-export dataset=Dを実行してください。復元前にアクティブなアノテーションを停止し、データセットがreadyに戻るまで待ってください。 images deleteとimages delete-bulkは完全削除を実行し、ゴミ箱を経由しません。datasets create-exportは、同一のスナップショットがすでに存在する場合、重複して作成せず再利用します。
ラベルと自動アノテーション
images update body='{"labels":[...]}'は画像上のすべてのラベルを置き換えます。また、images predictだけでは何も保存されません。一部だけを編集する場合は、まず取得してください。取得結果にlabelsTruncatedが含まれている場合、その画像のラベルは更新しないでください。置き換えによって、確認できなかったラベルが削除されるためです。datasets create-batch dataset=D body='{"modelId":"ul://OWNER/PROJECT/MODEL"}'はラベルのない画像に自動でラベルを付け、ラベルを保存してバージョンを作成します。クラス数が1~200の物体検出データセットでは、クラス名をプロンプトとして指定するホスト型モデルをmodelIdに指定することもできます:sam3.1(SAM 3.1 Text)、sam3、moondream、qwen、florence2、owlv2、yoloe26x、またはgroundingdino。ラベル付き画像も処理するには、body に"includeAnnotated":trueを追加してください(既存のラベルは保持されます)。datasets delete-batchは、すでに保存されたラベルを元に戻さずに実行をキャンセルまたは終了します。datasets create-batch dataset=D body='{"operation":"blur"}'は、データセット内の画像(body に"imageId"が含まれる場合は単一の画像)の顔をぼかします。バージョンは保存されないため、元の画像を保持する必要がある場合は、最初にdatasets create-exportを実行してください。- アノテーション予測では、互換性のあるタスクとクラス、または明示的なマッピングが必要です。
images predictにはclass_mapping=、datasets create-batchにはbody=内のclassMappingを使用してください。接続型データセット、深度データセット、またはチャンネル数が4以上のデータセットは拒否されます。
クラス、分割、タスク
class_namesはインデックスごとに名前を置き換えます。名前を変更する場合は順序を維持してください。クラスを統合または削除すると、ラベルの割り当てが変更または削除され、ID もずれます。datasets redistribute-splitsはデータセット全体を再シャッフルします。images update-bulkは選択した ID を移動します。競合ポリシーreplaceを指定すると、移動先の画像が削除されることがあります。datasets adopt-imagesは画像参照をラベルなしのトレーニング画像として追加し、既存の画像はスキップします。編集可能なデータセットからラベル、メタデータ、分割を引き継ぐのは、release=false(コピー)、release=true(移動)、またはclass_mappingの場合に限られます。taskを変更してもアノテーションは変換されません。深度への切り替え、または深度からの切り替えには、空のデータセットが必要です。
データセットの確認と分析
- 重複や分割間のデータ漏洩を調べるには、すべての画像レコードをハッシュでグループ化し、ID と分割を比較してください。ストレージの重複排除では、重複レコードは防げません。小さなページを使うか、エクスポートをダウンロードしてください。レコードが欠落している、または途中で切れている場合は、重複がゼロではなく、確認範囲が一部に限られると報告してください。
datasets retrieve dataset=Dはタスク、クラス、分割、件数を返します。datasets class-stats dataset=Dは分布とヒートマップを返します。sampleSizeが設定されている場合、統計は上限を設けたサブセットに基づいています。また、各ヒストグラムビンのsizeは幅です。objectsPerImageHistogramでは、binは下限を表します。bin=0, size=6はオブジェクトが 0 ~ 5 個の画像を数え、オブジェクトが 0 個の画像だけを数えるわけではありません。ラベルなし画像の件数を調べるには、datasets images dataset=D has_label=false limit=1を使い、totalを確認してください。- データセットの画像一覧には
datasets images dataset=Dを使います(images listはありません)。split、has_label、has_error、class_ids、searchで絞り込めます。件数だけを調べるには、limit=1を指定してtotalを確認してください(デフォルトで含まれます)。ページの件数ではありません。has_errorは、記録された処理エラーを意味します。一覧ページを小さくするにはinclude_thumbnails=falseを渡してください(include_image_urlsとinclude_labelsはデフォルトでオフです)。hasMoreが true の間は、nextCursorをcursorとして渡してください。カーソルが使えるのはnewestまたはoldestの並べ替え(デフォルトを含む)の場合だけです。それ以外の並べ替えではoffsetを使ってページ分割します。同じhashの値は、保存されたバイト列が同一であることを意味し、見た目が似ていることを意味するわけではありません。 search=TERMはファイル名(拡張子は省略可)、クラス名、メタデータのキー、スカラー値、配列の要素に含まれる部分文字列に一致しますが、ネストされたオブジェクト内の値には一致しません。フィールドを指定する機能はありません。一致したフィールドを確認するには、一致するレコードを取得してください。32 桁の 16 進数の検索語はコンテンツのhashに完全一致し、24 桁の 16 進数の検索語は画像 ID に一致します。そのため、search=HASHを使うとエクスポートせずに画像の保存済みコピーをすべて検索できます。- 一覧にはカスタム
metadataは含まれません。images retrieve image_id=IDはラベルとともにこれを返します。一覧と取得のどちらでも、ラベルが途中で切れることがあります。labelsTruncatedを確認し、返された件数をlabelCountまたは取得結果のproperties.annotationCountと比較してください。datasets selected-images dataset=D image_ids='["ID1","ID2"]'を使うと、既知の複数の ID を 1 回の呼び出しで取得できます。ID ごとにimages retrieveを呼び出す必要はありません。datasets imagesと同じinclude_*オプションを受け付けます。images urls image_ids='["ID1","ID2"]'は、1 つのデータセットから最大 100 個の ID の署名付き URL を更新します。datasets export dataset=Dは、一括集計用の NDJSON メタデータとアノテーションを提供します。オンプレミスのデータセットはエクスポートできません。 images find-similar-images image_id=IDは、公開データセット、自分のデータセット、チームのデータセットから類似画像を最大 24 件返します。ソースデータセットにすでにある画像と、クエリ画像の近重複コピーは除外されます。既存の画像 ID のみを指定でき、認証が必要です。埋め込みがない画像はオンデマンドで埋め込みが生成され、数分かかることがあります。503 は準備に失敗したことを意味するため、再試行してください。datasets embeddings dataset=Dは分析の最新状況と進行状況を報告します。datasets clustering dataset=Dは 2D UMAP の座標を返し、生の埋め込みは返しません。hasMoreが true の間は、デフォルトのページサイズを使う場合も含め、nextOffsetをoffsetとして渡してください。not_analyzedはレイアウトが存在しないことを意味します。詳細を確認するには、返された ID をdatasets selected-imagesで使用してください。datasets create-embeddingsは分析を開始します。datasets delete-embeddingsは分析をキャンセルしますが、画像は削除しません。
モデル分析と類似性
models retrieve project=P model=M analysis=1には認証が必要で、モデルの詳細ではなく画像ごとの検証analysisを返します。null は分析を利用できないことを意味します。画像ごとの結果が記録された検出実行が完了している必要があります。データセットのバージョンまたはマニフェストがない場合は、null の分析ではなく、traitsAvailable=falseおよびcoverage.mode="unavailable"を含むスコアが返されます。一般化する前に、populationとretainedを比較し、coverage.modeを確認してください。fullの場合にのみ、すべての検証画像が対象になります。traitsAvailableはcomparisons(画像の特性と F1 の比較)の有無を示します。cohorts.worstと.bestは、コホート全体のcountとmetricsを示しますが、examplesとして返されるのは最初の 100 件のみです。これらのラベルは現在のデータセットではなく、実行時に保存されたマニフェストから取得されます。scatterSample.rowsは[f1, width, height, pixels, aspectRatio, instanceCount]の点です。画像ごとのtp/fp/fn/f1は、実行時に記録されなかった信頼度しきい値で IoU 0.50 を使用します。そのため、別のしきい値でメトリクスを再構成することはできません。パフォーマンスの低さを診断する前に、モデルが報告する適合率/再現率を確認してください。これらの件数だけでは、デプロイ時の適合率を判断できず、特定の偽陽性の原因を説明することもできません。models find-similar-training-images project=P model=Mは、実行の検証結果が最も悪かった画像を基に、公開データセット、自分のデータセット、チームのデータセットを検索します。ただし、モデルのトレーニングデータセットにすでに含まれる画像は除外されます。モデルのワークスペースにアクセスできる認証情報を使用してください。このコマンドは候補を返すだけで、データセットには追加しません。hashes=H1,H2の値はすべてanalysis.cohorts.worst.examples[].hashから取得する必要があります。それ以外のハッシュが含まれると、リクエスト全体が拒否されます。コホートが記録されていない実行では空のリストが返されます。実行/データセットの識別子がない場合、または埋め込みを利用できない場合は、エラーが返されます。
接続済みストレージ
- 接続済みデータセット(クラウドストレージまたはオンプレミス)は、コピーされずにその場でインデックス化されます。アップロードの追加、バージョン作成、クローン作成、一括アノテーション、新しい埋め込み分析はできません。クラスタリングレイアウトが見つからない場合でも、分析を開始しないでください。
- インテグレーションを切断してもプロバイダー側のオブジェクトはそのまま残りますが、同じアカウントを再接続するまでデータセットにアクセスできなくなります。Roboflow の認証情報と Platform の認証情報は別々です。
使用状況と請求
account storageは、usage.<resource>.current/limit/percentとしてクォータを返します。limit=-1は無制限を意味します。details=trueを指定すると、完全な一覧ではなく、使用量が大きい上位 10 件のbreakdown.topItemsが追加されます。billing usage-summaryはプランの使用状況とクレジットを返します。billing transactions from_=START to=ENDでは、fromではなくfrom_を使用します。また、2026-09-01T00:00:00Zのような完全な ISO 日時が必要です。日付のみの指定は拒否されます。タイムスタンプはcreatedAtにあります。
コンピューティング
- モデルの
statusを編集しても、何かが開始または停止することはありません。 deployments list model=P/Mは、モデル ID やモデル名だけではなく、プロジェクトのモデルで絞り込みます。返されたdeploymentスラッグをdeployments retrieve、logs、metricsで使用してください。ログはnextPageTokenをpage_tokenとして指定してページングします。metrics range=は対象期間を選択し、sparkline=trueは完全なレスポンスではなく、コンパクトなダッシュボードの要約を返します。- デプロイメントの
deleteは取り消せません。デプロイメント用のゴミ箱はありません。 - エクスポートの
deleteは、実行中の変換をキャンセルするか、完了したファイルを削除します。ソースモデルには影響しません。
インストール済み CLI が正しい情報源です。ul version でバージョンを確認でき、ul cloud <resource> <operation> --help で有効な引数と選択肢を確認できます。このファイルに記載されたコマンド形式や注意事項よりも、エラーメッセージを優先してください。エンドポイントの仕様については、Platform API リファレンス と最新の /openapi.json を参照してください。