Skip to content

Commit 4faa13b

Browse files
committed
docs: Add SDK CHANGELOG.md for v0.2.0 release
1 parent b05e53e commit 4faa13b

File tree

1 file changed

+93
-0
lines changed

1 file changed

+93
-0
lines changed

docs/sdk/CHANGELOG.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.2.0] - 2025-11-12
9+
10+
### Added
11+
12+
- **AI Model Execution Support**
13+
- `call_model(model_id, input_text, parameters)` - Synchronous model execution via SDK
14+
- `call_model_async(model_id, input_text, parameters)` - Asynchronous execution (placeholder)
15+
- Support for multiple providers: OpenAI, Llama (Ollama, Together AI, Replicate), HuggingFace, Custom APIs
16+
- New API endpoints: `POST /api/aimodels/{id}/call/` and `POST /api/aimodels/{id}/call-async/`
17+
18+
- **HuggingFace Integration**
19+
- `hf_use_pipeline` field - Use Pipeline inference API
20+
- `hf_auth_token` field - Authentication token for gated models
21+
- `hf_model_class` field - Model head specification (8 variants)
22+
- `hf_attn_implementation` field - Attention function configuration
23+
- `framework` field - PyTorch or TensorFlow selection
24+
- Support for 8 model classes: CausalLM, Seq2SeqLM, SequenceClassification, etc.
25+
26+
- **CRUD Operations for AIModels**
27+
- `create(data)` - Create new AI models
28+
- `update(model_id, data)` - Update existing models
29+
- `delete_model(model_id)` - Delete models
30+
- PATCH HTTP method support in base client
31+
32+
- **Backend Services**
33+
- `ModelAPIClient` - Multi-provider API client with retry logic and statistics tracking
34+
- `ModelHFClient` - HuggingFace inference client with pipeline and manual loading support
35+
- Automatic GPU/CPU device selection
36+
- Request template system with placeholder replacement
37+
38+
- **New Enums**
39+
- `AIModelProvider.HUGGINGFACE` - HuggingFace provider
40+
- `AIModelFramework` - PyTorch/TensorFlow framework selection
41+
- `HFModelClass` - 8 model head types
42+
43+
- **Security & Access Control**
44+
- Organization-based model access control
45+
- Enhanced authentication checks for private models
46+
- Secure API key storage with encryption
47+
48+
### Changed
49+
50+
- Enhanced GraphQL queries to include HuggingFace-specific fields
51+
- Improved error handling for missing endpoints
52+
- Updated response format with standardized structure
53+
54+
### Fixed
55+
56+
- Type annotations for full mypy compatibility
57+
- Async/sync execution context handling
58+
- Response extraction for various providers
59+
- Union type issues with AnonymousUser
60+
61+
### Technical
62+
63+
- Full mypy type checking compatibility
64+
- Comprehensive type annotations throughout codebase
65+
- Connection pooling with httpx
66+
- Retry logic with exponential backoff (3 attempts)
67+
- Endpoint statistics tracking
68+
- Proper handling of Union types
69+
70+
### Dependencies
71+
72+
- Added `httpx>=0.28.1` - Async HTTP client
73+
- Added `tenacity>=9.1.2` - Retry logic
74+
- Added `torch>=2.9.0` - PyTorch support (optional)
75+
- Added `transformers>=4.57.1` - HuggingFace models (optional)
76+
- Added `nest-asyncio>=1.6.0` - Nested event loop support
77+
78+
## [0.1.0] - 2025-XX-XX
79+
80+
### Added
81+
82+
- Initial release of DataSpace SDK
83+
- Basic AIModel CRUD operations (read-only)
84+
- Dataset management
85+
- UseCase management
86+
- Search functionality
87+
- GraphQL support
88+
- Keycloak authentication
89+
- Organization and user management
90+
- Base API client with authentication
91+
92+
[0.2.0]: https://github.com/CivicDataLab/DataSpaceBackend/compare/v0.1.0...v0.2.0
93+
[0.1.0]: https://github.com/CivicDataLab/DataSpaceBackend/releases/tag/v0.1.0

0 commit comments

Comments
 (0)