コンテンツにスキップ

認証設定

MLdebugger SDKを使用するには、APIサーバーへの認証が必要です。このページでは、認証情報の取得方法と設定方法を説明します。

認証情報の取得

1. サインアップ

app.adansons.ai にアクセスし、アカウントを作成します。

  1. メールアドレスとパスワードを入力してサインアップ sign_up

  2. 確認メールを受信し、メールアドレスを認証

  3. ログイン後、チュートリアル app.adansons.ai/tutorial にアクセス (初回ログイン時に自動的に遷移します。) sign_in

2. API Keyの生成

チュートリアルからAPI Keyを生成します。

URL:https://app.adansons.ai/tutorial

  1. チュートリアルページに移動
  2. 「Generate API Key」をクリック
  3. 生成されたAPI Keyをコピー

api_key

API Keyの取り扱い

API Keyは秘密情報です。コードにハードコードしたり、公開リポジトリにコミットしないでください。

認証情報の設定方法

認証情報は以下の2つの方法で設定できます。

方法1: 環境変数（推奨）

環境変数を使用する方法が最も安全で推奨されます。

export MLD_API_ENDPOINT="https://api.adansons.ai"
export MLD_API_KEY="mldbg_*************"

import os

os.environ["MLD_API_ENDPOINT"] = "https://api.adansons.ai"
os.environ["MLD_API_KEY"] = "mldbg_*************"

# .env
MLD_API_ENDPOINT=https://api.adansons.ai
MLD_API_KEY=mldbg_*************

# Python側で読み込み
from dotenv import load_dotenv
load_dotenv()

方法2: 引数で直接指定

SDKのクラス初期化時に引数で直接指定することもできます。

from ml_debugger.training import ClassificationTracer

tracer = ClassificationTracer(
    model,
    model_name="my_model",
    version_name="v1",
    api_endpoint="https://api.adansons.ai",
    api_key="mldbg_*************",
)

優先順位

認証情報は以下の優先順位で適用されます：

  1. 引数で直接指定 - 最優先
  2. 環境変数 - 引数が未指定の場合に使用
# 例: api_keyのみ引数で指定、endpointは環境変数を使用
tracer = ClassificationTracer(
    model,
    model_name="my_model",
    version_name="v1",
    api_key="mldbg_different_key",  # この値が使用される
    # api_endpoint は環境変数 MLD_API_ENDPOINT を使用
)

環境変数一覧

環境変数名 説明 必須
MLD_API_ENDPOINT APIサーバーのURL Yes
MLD_API_KEY 認証用API Key Yes

トラブルシューティング

認証エラーが発生する場合

  1. API Keyの確認: API Keyが正しくコピーされているか確認
  2. 環境変数の確認: 環境変数が正しく設定されているか確認
  3. ネットワークの確認: APIサーバーにアクセスできるか確認
# 環境変数の確認
import os
print(f"Endpoint: {os.environ.get('MLD_API_ENDPOINT', 'Not set')}")
print(f"API Key: {os.environ.get('MLD_API_KEY', 'Not set')[:10]}...")

オフライン環境での使用

APIアクセスが不可能な環境では、Tracer.exportメソッドを使用してデータをエクスポートできます。

tracer.export("export_data.zip")

エクスポートしたファイルをAdansonsチームに送付することで、評価を依頼できます。

次のステップ