SIGNATE CLI

SIGNATE の公式APIコマンドラインインターフェイス(以下：SIGNATE CLI)です。 SIGNATEはData Science Competitionのご提供を始めとした、データサイエンティストの皆様のための統合プラットフォームです。

※SIGNATE CLIの動作にはPython3.8 以降の環境が必要です。 ※当CLIはβ版であり、予告なく変更させていただく可能性がございます。予めご了承ください。 ※SIGNATE CLIはMac OSおよびLinuxをサポートしております。

インストールと事前準備

以下のコマンドでインストールをお願いいたします。

$ pip install signate

インストール後、以下の手順を実施ください。

1. SIGNATE でアカウント登録 ※メールアドレス/パスワード 認証のみ
2. 以下のコマンドで登録したメールアドレスを指定して実行

$ signate token -e xxxxx@example.co.jp

3. パスワードを入力してサインイン（入力値は表示されません）

Password:

4. 以下のメッセージが表示されたら利用準備完了です。

The API Token has been downloaded successfully.

signate: command not found と表示される場合、環境変数$PATH のディレクトリ内にsignateが存在していることをご確認ください。pip uninstall signateコマンドで

• signateコマンドがインストールされているディレクトリの確認
• signateコマンドのアンインストール

が可能です。

Googleアカウントでサインインする場合

Googleアカウントでサインインする場合は、以下のコマンドを実行してください。

$ signate google-login

1. SIGNATE でGoogleアカウントでサインイン済み
2. 以下のコマンドを実行する

$ signate google-login

3. ブラウザが起動し、Googleアカウントでのサインインを求められるので、サインインを実行します
4. ブラウザを閉じ、CLIに戻ります。
5. 以下のメッセージが表示されたら利用準備完了です。

The API Token has been downloaded successfully.

利用方法

SIGNATE CLIでは以下の機能が利用できます。

$ signate --help
Usage: signate [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  competition-list
  download
  file-list
  google-login      Browser-based Google login.
  submit
  task-list
  token

① 投稿可能なコンペティション一覧の取得

$ signate competition-list

投稿可能なコンペティション一覧を表示します。

例：
$ signate competition-list

public_key                        title               remaining      reward           entry_count
--------------------------------  ------------------  -------------  -------------  -------------
0001d2723faa40b5a597832319f4722c  コンペティション1       360 seconds        100万円               1
c1001e081ca645dd9eb5c5a027fd8ecd  コンペティション2           26 days                             5

※上記 public_key は以降 <competition-public-key> として利用します。

② 投稿可能な課題一覧の取得

$ signate task-list --competition_key=<competition-public-key>

投稿可能な課題一覧を表示します。

例：
$ signate task-list --competition_key=0001d2723faa40b5a597832319f4722c

public_key                        task_name
--------------------------------  -----------
4d63b1cf2dd3462d902ac805f60d96ca  分類課題 データ1
4d63b1cf2dawega346gg02awe60d96cb  回帰課題 データ2

※上記 public_key は以降 <task-public-key> として利用します。

③ コンペティションが提供するファイル一覧の取得

こちらの機能をご利用の場合、コンペティションへの参加に同意いただく必要がございます(同意前の場合)。 コンペティションへの参加はブラウザから実行してください。

$ signate file-list --task_key=<task-public-key>

課題のファイル一覧を表示します。

例:
$ signate file-list --task_key=4d63b1cf2dd3462d902ac805f60d96ca

public_key                        file_name              title                  file_size
--------------------------------  ---------------------  ---------------------  -----------
sa9bc5b1f9ef45f6b79bdbeb281895f3  sample1.zip            学習用画像データ               60.65 MB
g5609de723b148fe8635754dcd1706fa  test_images.zip        評価用画像データ               26.49 MB

※上記 public_key は以降 <file-public-key> として利用します。

④ コンペティションが提供するファイルのダウンロード

こちらの機能をご利用の場合、コンペティションへの参加に同意いただく必要がございます(同意前の場合)。 コンペティションへの参加はブラウザから実行してください。

$ signate download --task_key=<task-public-key> --file_key=<file-public-key> [--path=<path>]
例:
$ signate download --task_key=4d63b1cf2dd3462d902ac805f60d96ca --file_key=sa9bc5b1f9ef45f6b79bdbeb281895f3

ファイルをダウンロードします。 デフォルトではカレントディレクトリにファイルがダウンロードされます。 --path=を指定すると、ダウンロード先のパスを指定できます。

例：
$ signate download --task_key=4d63b1cf2dd3462d902ac805f60d96ca --file_key=sa9bc5b1f9ef45f6b79bdbeb281895f3 --path=/tmp/test.zip

⑤ 投稿の実施

こちらの機能をご利用の場合、コンペティションへの参加に同意いただく必要がございます(同意前の場合)。 コンペティションへの参加はブラウザから実行してください。

$ signate submit --task_key=<task-public-key> --path=<結果ファイルのパス> [--memo="comment"] 

コンペティションに投稿を実施します。

例:
$ signate submit --task_key=4d63b1cf2dd3462d902ac805f60d96ca --path=~/test.zip --memo "提出物の説明などを記載"

Submission completed successfully.

補足

コンペティションへの同意

以下のようなメッセージが出力された際は

If you haven’t joined the competition yet, please do so through your browser.

ブラウザにて該当コンペティションに参加をお願いいたします。

ChangeLog

v0.13.0

• google-login コマンドを追加しました。

v0.12.0

• submit コマンドのオプションのファイル指定方法を --path に変更しました。
• download, submit コマンドでアップロード・ダウンロード時の進捗表示を追加しました。

v0.11.0

• 大容量の投稿ファイルのアップロードおよびデータセットファイルのダウンロードに対応しました。
• 古いバージョンをご利用の場合は、アップデートが必須の変更です。

ライセンス

SIGNATE CLIはApache 2.0 license. を適用しております。