BRain Language Vocab README

Brain Language Vocabulary — 設定 & 運用手順

  • 目的: brain_language の大きなトークン ID(例: 10000, 30000 等)を環境ごとにプレフィルし、起動時にロードしてデコーダの安定性を確保します。

  • 配置: サンプルファイルは config/brain_language_vocab.{environment}.json に配置します。

  • 例: config/brain_language_vocab.development.json, config/brain_language_vocab.staging.json, config/brain_language_vocab.production.json

  • 設定(settings.yaml)からの参照:

  • config/settings.yamlconfig/settings.{env}.yaml をマージし、次のキーを確認します:
brain_language:
  vocab_file: brain_language_vocab.development.json
  • vocab_file は相対パス(config/ 以下)または絶対パスを指定できます。
  • 指定がない場合は config/brain_language_vocab.json をデフォルトで読み込みます。

  • 起動時の挙動:

  • モジュール evospikenet.eeg_integration.brain_language_decoder はインポート時に上記設定を確認し、指定された JSON を読み込んで共有デコーダ _decoder_instance に語彙を登録します。
  • JSON のキーは文字列でも数値でも良いですが、内部では整数の token ID に変換されます。

  • 運用手順(例):

  • 環境用 JSON を作成: config/brain_language_vocab.production.json
  • config/settings.production.yamlbrain_language.vocab_file を設定
  • アプリ起動(またはテスト実行)で自動ロードされます

  • テスト:

  • 単体テスト: pytest tests/unit/eeg_integration を実行してください(コンテナ内での実行を推奨)。

  • 注意事項:

  • 起動時のロードはベストエフォートで失敗しても例外は投げないため、ログを確認して意図したファイルが読み込まれているか確認してください。
  • デコーダ語彙を更新する場合は BrainLanguageDecoder.update_vocab() を用いて実行時に追加可能です。

ファイル配置や動作に不明点があれば教えてください。追加した README は docs/BRain_Language_Vocab_README.md にあります。