Kaggle API 主要コマンド一覧
| カテゴリ | コマンド | 説明 |
|---|---|---|
| 全般 | kaggle -h |
Kaggle API全体のヘルプを表示します。 |
kaggle <サブコマンド> -h |
各サブコマンドのヘルプを表示します。 | |
| データセット | kaggle datasets list [-s <検索語>] |
データセットを検索・一覧表示します。 |
kaggle datasets download -d <owner/dataset> [-f <ファイル名>] [-p <パス>] [-u] |
データセットまたは特定のファイルをダウンロードします。(-u: 解凍) | |
kaggle datasets create -p <フォルダパス> [-r <zip/tar>] |
新しいデータセットを作成します。（要 dataset-metadata.json） |
|
kaggle datasets version -p <フォルダパス> -m "<更新メッセージ>" |
既存のデータセットを新しいバージョンに更新します。（要 dataset-metadata.json） |
|
kaggle datasets init -p <フォルダパス> |
データセットのメタデータファイル (dataset-metadata.json) のひな形を作成します。 |
|
kaggle datasets status <owner/dataset> |
データセットの作成・更新ステータスを確認します。 | |
kaggle datasets metadata <owner/dataset> [-p <フォルダパス>] |
データセットのメタデータを取得します。 | |
| コンペティション | kaggle competitions list [-s <検索語>] |
コンペティションを検索・一覧表示します。 |
kaggle competitions download -c <コンペ名> [-f <ファイル名>] [-p <パス>] [-u] |
コンペティションのデータまたは特定のファイルをダウンロードします。(-u: 解凍) | |
kaggle competitions submit -c <コンペ名> -f <提出ファイル> -m "<メッセージ>" |
コンペティションにファイルを提出します。 | |
kaggle competitions leaderboard -c <コンペ名> [-s] [-d] [-p <パス>] |
コンペティションのリーダーボードを表示またはダウンロードします。(-s: スコア表示) | |
kaggle competitions files -c <コンペ名> |
コンペティションのファイル一覧を表示します。 | |
kaggle competitions submissions -c <コンペ名> |
自分の提出履歴を表示します。 | |
| ノートブック | kaggle kernels list [-s <検索語>] [-u <ユーザー>] [-m] |
ノートブック（カーネル）を検索・一覧表示します。(-m: メタデータも) |
| (カーネル) | kaggle kernels pull <user/kernel> [-p <パス>] [-m] |
ノートブックをダウンロードします。(-m: メタデータも) |
kaggle kernels push -p <フォルダパス> |
ローカルのノートブックをKaggleにアップロード（新規作成/更新）します。（要 kernel-metadata.json） |
|
kaggle kernels status <user/kernel> |
ノートブックの実行ステータスを確認します。 | |
kaggle kernels output <user/kernel> [-p <パス>] |
ノートブックの実行結果（出力ファイル）をダウンロードします。 | |
kaggle kernels init -p <フォルダパス> |
ノートブックのメタデータファイル (kernel-metadata.json) のひな形を作成します。 |
|
| 設定 | kaggle config view |
現在のKaggle API設定値を表示します。 |
kaggle config set -n <名前> -v <値> |
Kaggle APIの設定値を変更します。（例: kaggle config set -n competition -v titanic） |
|
kaggle config unset -n <名前> |
Kaggle APIの設定値を削除します。 |
主なオプション:
-
-s <検索語>: 検索キーワードを指定します。 -
-d <データセット名>または-c <コンペ名>: 対象のデータセット名やコンペティション名を指定します。 -
-f <ファイル名>: 特定のファイルを指定します。 -
-p <パス>: ダウンロード先や作業フォルダのパスを指定します。 -
-uまたは--unzip: ダウンロードしたzipファイルを自動的に解凍します。 -
-m "<メッセージ>": 提出時やバージョン更新時のメッセージを指定します。 -
--quietまたは-q: 進行状況の出力を抑制します。
この表は主要なコマンドをまとめたものであり、全てのコマンドやオプションを網羅しているわけではありません。各コマンドの詳細な使い方やオプションについては、kaggle <コマンド> -h でご確認ください。