SIGNATE の公式APIコマンドラインインターフェイス(以下：SIGNATE CLI)です。
SIGNATEはData Science Competitionのご提供を始めとした、データサイエンティストの皆様のための統合プラットフォームです。
※SIGNATE CLIの動作にはPython3.6 以降の環境が必要です。
※当CLIはβ版であり、予告なく変更させていただく可能性がございます。予めご了承ください。
※SIGNATE CLIはMac OSおよびLinuxをサポートしております。
以下のコマンドでインストールをお願いいたします。
$ pip install signate
インストール後、以下の手順を実施ください。
- SIGNATE でアカウント登録
- アカウント登録後、アカウント設定 画面の "API Token" の "作成" をクリック
- "新規作成" をクリックしてAPI Token(
signate.json)を取得 - 取得したAPI Tokenを
~/.signate直下に配置
＊ SIGNATE CLI 上でも API Token は取得できます。詳しくは「利用方法」⑤をご参照ください。
＊ SNS で会員登録した場合はアカウント設定 画面でのみ API Token を取得可能です。
以下のコマンドでヘルプが表示されましたら利用準備完了です。
$ signate --help
signate: command not found と表示される場合、環境変数$PATH のディレクトリ内にsignateが存在していることをご確認ください。pip uninstall signateコマンドで
- signateコマンドがインストールされているディレクトリの確認
- signateコマンドのアンインストール
が可能です。
SIGNATE CLIでは以下の機能が利用できます。
$ signate --help
Usage: signate [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
download Download the file of competition
files List file of competition
list List competition
submit Submit a result file to the competition
token Download the API Token
$ signate list
投稿可能なコンペティション一覧を表示します。
$ signate list
competitionId title closing prize participants
------------- ---------------- ------------------- --------- --------------
1 a-ai-competition - $200,00 100
2 b-ai-competition 2019-12-31 Knowledge 50
……$ signate files --competition-id=<competition-id>
コンペティションが提供するファイルの一覧を表示します。
$ signate files --competition-id=1
fileId name title size updated_at
-------- ----------------- -------------- ------- -------------------
1 train.csv 学習用データ 2345067 2016-05-31 11:19:48
2 test.csv 検証用データ 1523536
……こちらの機能をご利用の場合、コンペティションへの参加に同意いただく必要がございます(同意前の場合)。
詳しくは補足 コンペティションへの同意をご確認ください。
$ signate download --competition-id=<competition-id>
コンペティションが提供するファイルをダウンロードします。
デフォルトの場合カレントディレクトリにファイルがダウンロードされます。
competition-idのみを指定した場合、該当コンペティションが提供するすべてのファイルがダウンロード対象となります。
$ signate download --competition-id=1
submit_sample.csv
100% [.................................................................] 205890 / 205890
test.csv
100% [.................................................................] 1523536 / 1523536
train.csv
100% [.................................................................] 2345067 / 2345067
Download completed.
以下のようにご指定いただくことで、ダウンロードするファイルの指定とダウンロード先のパス指定もそれぞれ可能です。
$ signate download --competition-id=1 --file-id=1 --path=/Users/[user_name]/Desktop/
train.csv
100% [.................................................................] 2345067 / 2345067
Download completed.
こちらの機能をご利用の場合、コンペティションへの参加に同意いただく必要がございます(同意前の場合)。
詳しくは補足 コンペティションへの同意をご確認ください。
signate submit --competition-id=<competition-id> <結果ファイルのパス>コンペティションにデータセットを提出します。
$ signate submit --competition-id=1 /Users/[user_name]/Desktop/result.csv
You have successfully submitted your predictions. We will send you the submission result to your email address.コメントを残すことも可能です。
$ signate submit --competition-id=1 /Users/[user_name]/Desktop/result.csv --note 頑張りました
You have successfully submitted your predictions. We will send you the submission result to your email address.APIトークン取得コマンドを実行し、APIでアクセスに必要なトークンを取得します。
$ signate token --email=事前準備で登録したemail --password=事前準備で登録したパスワード
The Api Token successfully downloaded.以下のようなメッセージが出力された際は
You have not accepted the competition terms of use!
Do you accept the competition terms of use?
Please read the terms of use before accepting: https://signate.jp/competitions/*#terms
[y/N]:
リンク先をご一読いただき、y のご入力をお願いいたします。以降、同一コンペティションで当メッセージは表示されません。
You have not filled in user infomation to join the competition. Go to https://signate.jp/profile.
のメッセージが表示された場合はSIGNATEにアクセスいただき、プロフィールのご入力をお願いいたします。
SIGNATE CLIはApache 2.0 license. を適用しております。