ait-cli 1.0.1

Command Line Tools for AIT

AIT-CLI

概要

AIT-CLI は、AIT開発に関連するコマンドラインツールです。このツールを使用すると、以下の操作をコマンドラインから簡単に実行できます。

• AITテンプレートの作成
• AIT開発環境のJupyter Labの起動
• サードパーティの通知生成
• AITパッケージの圧縮
• AITのGitHubへのプッシュ

これにより、AITのセットアップや操作を効率的に行うことができます。

対象ユーザー

• AIT開発者

インストール方法

以下のコマンドでインストールできます。

pip install ait-cli

[!IMPORTANT] ローカル環境（システム全体）にインストールした場合、ait-cliコマンドはシステム全体で利用可能です。仮想環境にインストールした場合、ait-cliコマンドはインストールした仮想環境でのみ利用可能です。

[!TIP]

Windows

Windowsにインストールする際、権限の問題でインストール時にait-cliの実行ファイルが作成されない場合があります。その場合は、pip install ait-cliを管理者権限で立ち上げたコマンドプロンプトで実行してください。

Mac, Linux

MacまたはLinuxにインストールする際、ait-cliのパスが通らない場合があります。bashrcもしくはzshrcを修正して、ait-cliの実行ファイル（binファイル）のパスを通してください。 通常、実行ファイルは~/.local/binに作成されます。
bashの例

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

実行環境

AIT-CLIは「gitコマンドの使用」「gitのuser.emailとuser.nameの設定」「GitHubへのSSH接続」「dockerコマンドの使用」を前提としております。 以下コマンドの実行結果がそれぞれ問題ないことを確認してください。

• gitコマンド

git --version
# 「git version ～」のようにgitのバージョンが表示されることを確認してください

• user.emailとuser.nameの設定

git config --global user.email
# Eメールが表示されることを確認してください

git config --global user.name
# 名前が表示されることを確認してください

• GitHubへのSSH接続

ssh -T [e-mail]
# 「Hi <ユーザ名>! You've successfully authenticated, but GitHub does not provide shell access.」のようなメッセージが表示されることを確認してください

• dockerコマンド

docker --version
# 「Docker version ～」のようにdockerのバージョンが表示されることを確認してください

インストールや設定方法についてはリンク先でご確認ください。

• git: https://git-scm.com/
• GitHubへのSSH接続: https://docs.github.com/ja/authentication/connecting-to-github-with-ssh
• docker: https://www.docker.com/ja-jp/

[!CAUTION] 本ガイド執筆時点で、Docker Desktopの無償利用には条件があり、必ずしも利用者の手元において問題なく利用できるとは限りません。ご自身で使用許諾条件を確認いただく必要があります。

使用方法

コマンド構成

ait-cliは、複数のサブコマンドを提供しています。以下のコマンドでヘルプを確認できます。

ait-cli --help

サブコマンド

以下のサブコマンドを利用できます。

コマンド	説明	オプション
create	AITテンプレートをセットアップする	--ait_name: 開発するAITの名前（必須） --path: AITの配置先のパス
jupyter	AITをJupyter Labで起動する	--path: Jupyter Labを起動するAITのパス
thirdparty-notice	AITのサードパーティライセンス通知を生成	--path: サードパーティ通知を生成するAITのパス
zip	AITをzipに圧縮する	--path: 圧縮するAITのパス
git-push	AITを指定したGitHubのリポジトリにプッシュする	--github_repository: GitHubリポジトリURL（初回のプッシュ時に必須） --path: プッシュするAITのパス

createコマンド

指定したディレクトリに、--ait_nameで指定した名前のAITテンプレートをセットアップします。

ait-cli create --ait_name <YourAITName> --path <directory path>

引数

• --ait_name: 開発するAITの名前（必須）
• --path: AITの配置先のパス。デフォルトは現在のディレクトリ

AITの命名規則

AITの命名時に推奨される命名規則は以下の通りです。

• {prefix}_{target}_{format}_{task}_{measure}

項目名	必須	説明
prefix	○	AITのタイプを表します。 - eval : 品質評価 - alyz : 分析 - misc : その他 - generate : AITに入力するデータを生成するAITに使います。
target	○	AITの評価対象によって"dataset"か"model"のいずれかを選択します。
task	×	AITが対象とする問題 例.image_classifier
format	×	AITが取り扱うデータの形式 例. table
measure	×	AITで取り扱う品質特性 例. coverage_of_dataset

• 制限
  • 名称は50文字以下にする必要があります
  • 利用可能な文字は、半角英数字 と _ です

jupyterコマンド

AITをJupyter Labで起動します。

ait-cli jupyter --path <directory path>

引数

• --path: Jupyter Labを起動するAITのパス。デフォルトは現在のディレクトリ

[!TIP] dockerが起動していない場合、Jupyter Labは起動しません。

thirdparty-noticeコマンド

AITのサードパーティ通知を生成します。

ait-cli thirdparty-notice --path <directory path>

引数

• --path: サードパーティ通知を生成するAITのパス。デフォルトは現在のディレクトリ

[!CAUTION] thirdparty-noticコマンドはOSSライセンスの完全なリストアップを保証しません。必ずご自身で内容を確認してください

zipコマンド

AITをzip圧縮します。

ait-cli zip --path <directory path>

引数

• --path: 圧縮するAITのパス。デフォルトは現在のディレクトリ

[!TIP] zipパッケージがインストールされていない場合、このコマンドは失敗します。特にLinux環境で頻発する問題です。sudo apt-get install zipを実行したのちに、再度ait-cli zipの実行をお願いします。

git-pushコマンド

AITを指定したGitHubのリポジトリにプッシュします。

ait-cli git-push --github_repository <Your GitHub repository URL> --path <directory path>

引数

• --github_repository: 最初のプッシュ時にGitHubリポジトリのURLを指定してください。2回目以降は省略可能です。2回目以降のプッシュ時にURLを上書きする場合にはこのオプションを指定してください。
• --path: プッシュするAITのパス。デフォルトは現在のディレクトリ

[!CAUTION] GITHUBへ登録すると、開発したAITは一般公開されます。AITの公開に際しては、個人情報や機密情報を公開していないか、また公開が目的に即しているか、十分確認した上で実施してください。

使用例

実際のAIT開発フローに沿った使用例を紹介します。

1. AIT-CLIをインストール

pip install ait-cli

2. AITテンプレートをセットアップ

ait-cli create --ait_name AIT_sample

3. ディレクトリを移動し、Jupyter Labを立ち上げる

cd AIT_sample
ait-cli jupyter

4. Jupyter Lab内でAITの開発とユニットテスト

5. サードパーティ通知の生成

ait-cli thirdparty-notice

6. Qunomonとの結合テスト用にAITをzipに圧縮

ait-cli zip

7. 結合テストを実施

8. 開発したAITをGitHubに登録

ait-cli git-push --github_repository [e-mail]:~

AIT開発の詳細なガイドについてはこちらをご確認ください
https://aistairc.github.io/qunomon/ait-guide/index.html

トラブルシューティング

エラー: createコマンドが失敗した場合

Error: Failed to clone the repository. Please check your network connection or the repository URL.
Details: Command execution failed with error code: <エラーコード>
...

解決策: gitがインストールされているか、GitHubとSSH接続が確立できているか、PCがオンラインであるか、を確認してください。

エラー: スクリプトが見つからない

Error: Script '<script_name>' not found. Please verify the path.

解決策: ait-cliコマンドがAITのルートディレクトリで実行されているか、--pathオプションが正しいか、を確認してください。

エラー: ディレクトリが見つからない

Error: Directory '<directory_name>' not found. Please verify the path.

解決策: ait-cliコマンドがAITのルートディレクトリで実行されているか、--pathオプションが正しいか、を確認してください。

作成者

AIST AIRC

ライセンス

Apache License Version 2.0