kaggle APIとは

kaggle APIを活用すると、データセットダウンロードやsummitなどの操作が、CUIで操作できるようになります。
なお、APIのみでしか出来ない操作はないそうなので、ブラウザで操作したい方はそっとこのページを閉じてください。

kaggle APUを活用する

では早速kaggle APIの活用方法を記載したいと思うのですが、簡単に前提と本記事のゴールと流れを以下に記載します。

前提

PC：macOS Catalina

ゴール

CUI(ターミナル)で
・kagleのデータセットをダウンロードする
・コンペ情報の確認
・submitする

大まかな流れ

1.kaggle APIトークンの入手
2.kaggle APIのインストール
3.実行

1.kaggle APIトークンの入手

まずは、Kaggleにアクセスし、サイトの右上自分のアイコンをクリック -> My Account -> APIの項目の"Create New API Token"をクリックしダウンロードします。

2.kaggle APIのインストール

ターミナルを立ち上げて

pip install kaggle

終了後念の為に利用できるかどうかの確認、

which kaggle

そうしたら先程、ダウンロードしたトークンをkaggleのディレクトリに移動します。

mv ~/.Downloads/kaggle.json ~/.kaggle/

そして、実行できるように、

chmod 600 ~/.kaggle/kaggle.json

のコマンドを実行します。
これで、利用できるはずです。
試しに、以下のコマンドを実行してみてください。

kaggle competitions list

このような、表示がされれば設定完了です！

3.実行

では、実際にkaggle APIを活用して色々とやってみましょう。
・データセットのダウンロード

kaggle c download -c titanic -p ./Downloads/

今回はtitanicコンペのデータセットをダウンロードしていますが、もちろん titanic を他のコンペ名にすると他のデータセットもダウンロード可能です。

・submitする

kaggle competitions submit -c titanic -f submission.csv -m test

submission.csv というファイルをsubmitしています。

ちなみに、以下のコマンドを実行することによって、ヘルプを参照することが出来ます。

kaggle c -h

以上で今回の記事は終わりです。

最後に

万が一、誤りや改善したほうがいい点などありましたら、お気軽にコメントやリクエスト頂けると嬉しいです。