Skip to content

EvoSpikeNet SDK Document Index

[!NOTE] For the latest implementation status, please refer to Functional Implementation Status (Remaining Functionality).

📚 Document list

Main documentation

Documentation Description Target audience
SDK README SDK overview and quick start All users
SDK API Reference Complete API specification and method details Developer
SDK Tutorial Step-by-step usage guide Beginner to intermediate users
SDK Installation Guide Detailed setup instructions Administrators/Developers
SDK Developer Guide Extension/Development/Test Information Senior Developer

Supporting documentation

Documentation Description
SDK Change History Version History and Migration Guide
SDK Quick Start Guide to get started in 30 seconds
SDK Configuration Management API key/authentication settings

🚀 Quick start

For new users

  1. Read the SDK README to get an overview
  2. Build the environment with SDK Installation Guide
  3. Try basic usage with SDK Quick Start
  4. Learn detailed usage in SDK Tutorial

For developers

  1. Set up the development environment with SDK Developer Guide
  2. Check the API specifications in SDK API Reference
  3. See practical usage examples in sample code (docs/sdk/)
  4. Run the test to see if it works

📖 Learning Path

Beginner (first time user)```

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

#### Intermediate (with basic usage experience)```
SDKチュートリアル → SDK APIリファレンス → 高度なサンプルコード

Advanced (planning SDK expansion and development)```

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

💡 Sample code

Basic sample

File Description Difficulty
simple_generation.py Basic text generation Beginner
multimodal_generation.py Image/audio input processing Intermediate
run_simulation_query.py Distributed brain simulation Intermediate
distributed_video_asr_demo.py Confirmation of SDK execution assuming ASR/Whisper settings on distributed nodes Intermediate

Advanced samples

File Description Difficulty
advanced_features_demo.py Snapshot/Zenoh/Consensus Advanced
async_operations_demo.py Asynchronous processing and parallel execution Advanced
batch_generation.py Batch processing and progress monitoring Intermediate
error_handling_example.py Robust error handling Intermediate
genome_management_sdk.py Genome list, storage, and application Intermediate

🔍 Functional reference

Core features

Features Related Documents Samples
Text generation Tutorial simple_generation.py
Multimodal processing Tutorial multimodal_generation.py
Distributed brain simulation Tutorial run_simulation_query.py
Artifact Management Tutorial get_simulation_artifact.py

Advanced features

Features Related Documents Samples
Snapshot management API reference advanced_features_demo.py
Scalability Test API Reference advanced_features_demo.py
Zenoh Communication API Reference advanced_features_demo.py
AEG-Comm communication optimization API reference aeg_comm_demo.py
Distributed consensus API reference advanced_features_demo.py
Distributed Coordinator API Reference distributed_coordinator_demo.py
Asynchronous processing API Reference async_operations_demo.py
Evolution/Genome Management API Reference genome_management_sdk.py

Development/operation functions

Features Related Documents
Error Handling Tutorial
Batch processing Tutorial
Monitoring and Statistics Tutorial
Jupyter integration Tutorial

🛠️ Development Resources

For developers

Resources Description
Developer Guide SDK extension/development information
Test Test Creation Guide
Performance Optimization method
Security Security Best Practices

API specifications

Resources Description
API Reference Complete method specification
Data type Type definition and enumeration
Error Handling Error classes and processing

📋 Checklist

Setup completion check

  • [ ] Python 3.8+ is installed
  • [ ] SDK is installed (pip install -e .)
  • [ ] API server is running
  • [ ] Basic sample code works

Learning completion check

  • [ ] Read SDK README
  • [ ] Tried SDK Quick Start
  • [ ] Can perform basic text generation
  • [ ] Tried distributed brain simulation
  • [ ] Understood artifact management

Development readiness check

  • [ ] Read SDK Developer Guide
  • [ ] Test environment is in place
  • [ ] Code quality tools are installed
  • [ ] I understand the contribution guidelines.

🎯 Support

Questions/Problem Solving

  1. Document Search: Find related documents in this index
  2. Sample code: See sample in docs/sdk/
  3. API Reference: Check detailed method specifications
  4. Community: Ask a question in GitHub Issues/Discussions

Common issues

Problem Solution
Installation error Installation Guide
Connection error Installation Guide
API error Tutorial
Performance Issues Developer Guide

📝 Document update history

Date Update
2026-01-15 SDK 2.0 documentation set created
2025-12-21 First document creation

📞 Contact

Last updated: January 15, 2026 /Users/maoki/Documents/GitHub/EvoSpikeNet/docs/SDK_DOCUMENTATION_INDEX.md