EvoSpikeNet SDK ドキュメントインデックス

[!NOTE] 最新の実装状況は 機能実装ステータス (Remaining Functionality) を参照してください。

📚 ドキュメント一覧

主要ドキュメント

ドキュメント	説明	対象読者
SDK README	SDKの概要とクイックスタート	全ユーザー
SDK APIリファレンス	完全なAPI仕様とメソッド詳細	開発者
SDKチュートリアル	ステップバイステップの使用ガイド	初級～中級ユーザー
SDKインストールガイド	詳細なセットアップ手順	管理者・開発者
SDK開発者ガイド	拡張・開発・テスト情報	上級開発者
SDKデバイスプラグイン開発ガイド	DevicePlugin の作成方法とテンプレート	SDK拡張開発者
SDK Loihi Brain2Loihi 実行ガイド	Brain2Loihi シミュレータのビルド・設定・実行手順	DevicePlugin 実行者

補助ドキュメント

ドキュメント	説明
SDK変更履歴	バージョン履歴と移行ガイド
SDKクイックスタート	30秒で始めるガイド
SDK構成管理	APIキー・認証設定

🚀 クイックスタート

新規ユーザー向け

1. SDK README を読んで概要を把握
2. SDKインストールガイド で環境構築
3. SDKクイックスタート で基本的な使用を試す
4. SDKチュートリアル で詳細な使用方法を学習

開発者向け

1. SDK開発者ガイド で開発環境をセットアップ
2. SDK APIリファレンス でAPI仕様を確認
3. サンプルコード（docs/sdk/）で実践的な使用例を参照
4. テストを実行して動作を確認

📖 学習パス

レベル別推奨学習順序

初級者（初めてのユーザー）

SDK README → SDKインストールガイド → SDKクイックスタート → 基本サンプルコード

中級者（基本的な使用経験あり）

SDKチュートリアル → SDK APIリファレンス → 高度なサンプルコード

上級者（SDK拡張や開発を予定）

SDK開発者ガイド → SDK APIリファレンス → テストコード → ソースコード

💡 サンプルコード

基本サンプル

ファイル	説明	難易度
simple_generation.py	基本的なテキスト生成	初級
multimodal_generation.py	画像・音声入力処理	中級
run_simulation_query.py	分散脳シミュレーション	中級
distributed_video_asr_demo.py	分散ノードへのASR/Whisper設定前提でのSDK実行確認	中級
rag_v2_sdk_demo.py	RAG v2 の search / feedback / preprocessing health を SDK 経由で確認	中級
device_plugin_template.py	DevicePlugin の最小実装と登録・スモーク実行	中級
ibm_quantum_runtime_demo.py	IBM Runtime 接続確認と Sampler/Estimator 実行例	上級
ibm_neurochip_demo.py	IBM NeuroChip DevicePlugin の simulator 実行（最適化・変換・デプロイ）	上級
vqe_neuron_layer_demo.py	VQENeuronLayer の実行と固有値トラッキング確認	上級
loihi_brain2loihi_demo.py	Loihi Brain2Loihi シミュレータ実行（最適化・変換・デプロイ・スパイク実行）	上級

高度なサンプル

ファイル	説明	難易度
advanced_features_demo.py	スナップショット・Zenoh・コンセンサス	上級
async_operations_demo.py	非同期処理と並行実行	上級
batch_generation.py	バッチ処理とプログレス監視	中級
error_handling_example.py	堅牢なエラーハンドリング	中級
genome_management_sdk.py	ゲノム一覧・保存・適用	中級

🔍 機能別リファレンス

コア機能

機能	関連ドキュメント	サンプル
テキスト生成	チュートリアル	simple_generation.py
マルチモーダル処理	チュートリアル	multimodal_generation.py
分散脳シミュレーション	チュートリアル	run_simulation_query.py
アーティファクト管理	チュートリアル	get_simulation_artifact.py
RAG v2 検索/運用確認	APIリファレンス	rag_v2_sdk_demo.py

高度な機能

機能	関連ドキュメント	サンプル
スナップショット管理	APIリファレンス	advanced_features_demo.py
スケーラビリティテスト	APIリファレンス	advanced_features_demo.py
Zenoh通信	APIリファレンス	advanced_features_demo.py
AEG-Comm通信最適化	APIリファレンス	aeg_comm_demo.py
分散コンセンサス	APIリファレンス	advanced_features_demo.py
分散Coordinator	APIリファレンス	distributed_coordinator_demo.py
非同期処理	APIリファレンス	async_operations_demo.py
進化/ゲノム管理	APIリファレンス	genome_management_sdk.py

開発・運用機能

機能	関連ドキュメント
エラーハンドリング	チュートリアル
バッチ処理	チュートリアル
監視と統計	チュートリアル
Jupyter統合	チュートリアル

🛠️ 開発リソース

開発者向け

リソース	説明
開発者ガイド	SDK拡張・開発情報
テスト	テスト作成ガイド
パフォーマンス	最適化手法
セキュリティ	セキュリティベストプラクティス

API仕様

リソース	説明
APIリファレンス	完全なメソッド仕様
データ型	型定義と列挙型
エラーハンドリング	エラークラスと処理

📋 チェックリスト

セットアップ完了チェック

• [ ] Python 3.8+ がインストールされている
• [ ] SDKがインストールされている (pip install -e .)
• [ ] APIサーバーが起動している
• [ ] 基本的なサンプルコードが動作する

学習完了チェック

• [ ] SDK README を読んだ
• [ ] SDKクイックスタート を試した
• [ ] 基本的なテキスト生成ができる
• [ ] 分散脳シミュレーションを試した
• [ ] アーティファクト管理を理解した

開発準備チェック

• [ ] SDK開発者ガイド を読んだ
• [ ] テスト環境が整っている
• [ ] コード品質ツールがインストールされている
• [ ] 貢献ガイドラインを理解した

🎯 サポート

質問・問題解決

1. ドキュメント検索: このインデックスから関連ドキュメントを探す
2. サンプルコード: docs/sdk/ のサンプルを参照
3. APIリファレンス: メソッドの詳細仕様を確認
4. コミュニティ: GitHub Issues/Discussions で質問

一般的な問題

問題	解決策
インストールエラー	インストールガイド
接続エラー	インストールガイド
APIエラー	チュートリアル
パフォーマンス問題	開発者ガイド

📝 ドキュメント更新履歴

日付	更新内容
2026-05-22	rag_v2_sdk_demo.py と RAG v2 SDK メソッド説明を追加
2026-05-17	IBM NeuroChip DevicePlugin サンプル (ibm_neurochip_demo.py) と関連ガイドを追加
2026-05-16	SDKデバイスプラグイン開発ガイド、テンプレート、IBM Runtimeデモサンプルを追加
2026-01-15	SDK 2.0ドキュメント一式作成
2025-12-21	初回ドキュメント作成

---

📞 連絡先

• プロジェクト: EvoSpikeNet
• SDK Issues: GitHub Issues
• Discussions: GitHub Discussions

最終更新日: 2026年5月22日 /Users/maoki/Documents/GitHub/EvoSpikeNet/docs/SDK_DOCUMENTATION_INDEX.md