superb-ai-onprem 0.6.3__tar.gz → 0.7.0__tar.gz

superb_ai_onprem-0.7.0/PKG-INFO

@@ -0,0 +1,285 @@
+Metadata-Version: 2.4
+Name: superb-ai-onprem
+Version: 0.7.0
+Summary: Python SDK for Superb AI On-premise
+Home-page: https://github.com/Superb-AI-Suite/superb-ai-onprem-python
+Author: Superb AI
+Author-email: support@superb-ai.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.22.0
+Requires-Dist: urllib3>=1.21.1
+Requires-Dist: pydantic>=1.8.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 🚀 Superb AI On-premise Python SDK
+
+![Python](https://img.shields.io/badge/python-3.7+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+![Version](https://img.shields.io/pypi/v/superb-ai-onprem.svg)
+
+**Superb AI On-premise Python SDK** is a comprehensive Python library that provides a simple and intuitive interface to interact with your on-premise Superb AI installation. Build powerful data management, annotation, and machine learning workflows with ease.
+
+## 🌟 Key Features
+
+- **🗂️ Dataset Management**: Create, organize, and manage your datasets
+- **📊 Data Operations**: Upload, annotate, and manipulate your data with powerful filtering
+- **🔍 Advanced Filtering**: Sophisticated filtering system for precise data queries  
+- **🏷️ Annotation Management**: Handle annotations and versions seamlessly
+- **📤 Export & Import**: Flexible data export and content management
+- **⚡ Activity Tracking**: Monitor and manage long-running tasks
+- **🔧 Slice Management**: Organize data into logical groups
+
+## 🔧 Installation
+
+### Step 1: Install the SDK
+
+Install the SDK using pip:
+
+```bash
+pip install superb-ai-onprem
+```
+
+**Requirements:**
+- Python 3.7 or higher
+- Active Superb AI On-premise installation
+
+> ⚠️ **Important**: The SDK will not work without this configuration file. Make sure to replace the values with your actual credentials from your Superb AI administrator.
+
+## 🚀 Quick Start
+
+Get up and running with Superb AI SDK in minutes:
+
+### Step 1: Authentication Setup
+
+First, set up your authentication credentials:
+
+**Option A: Config file (Recommended for local development)**
+```bash
+# Create config directory
+mkdir -p ~/.spb
+
+# Create config file
+cat > ~/.spb/onprem-config << EOF
+[default]
+host=https://your-superb-ai-host.com
+access_key=your-access-key
+access_key_secret=your-access-key-secret
+EOF
+```
+
+### Step 2: Your First Workflow
+
+```python
+from spb_onprem import DatasetService, DataService
+
+# Initialize services
+dataset_service = DatasetService()
+data_service = DataService()
+
+# 1. Find existing datasets
+datasets, cursor, total = dataset_service.get_dataset_list(length=10)
+print(f"📂 Found {total} datasets")
+
+if datasets:
+    # Use the first available dataset
+    dataset = datasets[0]
+    print(f"✅ Using dataset: {dataset.name} (ID: {dataset.id})")
+    
+    # 2. Get data list from the dataset
+    data_list, cursor, total = data_service.get_data_list(
+        dataset_id=dataset.id,
+        length=10
+    )
+    
+    print(f"📊 Dataset contains {total} data items")
+    
+    # 3. Display data information
+    for i, data in enumerate(data_list, 1):
+        print(f"  {i}. Key: {data.key}, Type: {data.type}, ID: {data.id}")
+        
+    if total > len(data_list):
+        print(f"  ... and {total - len(data_list)} more items")
+else:
+    print("❌ No datasets found. Please create a dataset first.")
+```
+
+**🎉 Congratulations!** You've successfully:
+- ✅ Connected to your Superb AI instance
+- ✅ Found existing datasets
+- ✅ Retrieved and displayed data information
+
+Ready for more? Check out our [comprehensive documentation](#-documentation) below!
+
+## 📚 Module Documentation
+
+### 🏗️ Core Modules
+
+Comprehensive guides for each SDK module with detailed examples and best practices:
+
+| Module | Purpose | Key Features | Documentation |
+|--------|---------|--------------|---------------|
+| **📁 Datasets** | Dataset lifecycle management | Create, organize, manage data collections | [📂 Dataset Guide](spb_onprem/datasets/README.md) |
+| **📊 Data** | Individual data management | CRUD operations, advanced filtering, annotations | [📊 Data Guide](spb_onprem/data/README.md) |
+| **🔪 Slices** | Data organization & filtering | Create filtered views, team collaboration | [� Slice Guide](spb_onprem/slices/README.md) |
+| **⚡ Activities** | Workflow & task management | Process automation, progress tracking | [⚡ Activity Guide](spb_onprem/activities/README.md) |
+| **📤 Exports** | Data & annotation export | Multi-format export (COCO, YOLO, Custom) | [📤 Export Guide](spb_onprem/exports/README.md) |
+
+### 🎯 Getting Started Paths
+
+Choose your learning path based on your use case:
+
+#### **📊 Data Management Workflow**
+1. Start with [� Datasets](spb_onprem/datasets/README.md) - Create and organize your data collections
+2. Then explore [📊 Data](spb_onprem/data/README.md) - Manage individual items and annotations  
+3. Use [🔪 Slices](spb_onprem/slices/README.md) - Organize data into logical groups
+
+#### **🚀 ML Pipeline Integration**
+1. Begin with [� Data](spb_onprem/data/README.md) - Understand data structure and filtering
+2. Configure [⚡ Activities](spb_onprem/activities/README.md) - Automate labeling and review workflows
+3. Setup [� Exports](spb_onprem/exports/README.md) - Export to ML training formats
+
+#### **👥 Team Collaboration**
+1. Setup [📁 Datasets](spb_onprem/datasets/README.md) - Organize team projects  
+2. Create [🔪 Slices](spb_onprem/slices/README.md) - Assign work to team members
+3. Implement [⚡ Activities](spb_onprem/activities/README.md) - Track progress and quality
+
+### 🔧 Advanced Features
+
+Each module includes:
+- **🎯 Quick Start Examples** - Get running immediately
+- **📋 Detailed Entity Documentation** - Pydantic models with comprehensive field descriptions  
+- **🔍 Advanced Usage Patterns** - Best practices and complex workflows
+- **🔗 Cross-Module Integration** - How modules work together
+- **⚡ Performance Tips** - Optimization recommendations
+
+### 🌐 Module Relationships
+
+```
+📁 Datasets (containers)
+├── 📊 Data (individual items) 
+│   ├── 🔪 Slices (filtered views)
+│   └── ⚡ Activities (processing workflows)
+└── 📤 Exports (output formats)
+```
+
+### ⚠️ Deprecated Modules
+
+| Module | Status | Migration Path |
+|--------|--------|----------------|
+| **ModelService** | 🚫 Deprecated | Use external ML frameworks |
+| **PredictionService** | 🚫 Deprecated | Use [📊 Data](spb_onprem/data/README.md) prediction entities |
+| **InferService** | 🚫 Deprecated | Use [⚡ Activities](spb_onprem/activities/README.md) for inference workflows |
+
+
+
+
+
+## ⚠️ Error Handling
+
+The SDK provides specific error types for different scenarios:
+
+```python
+from spb_onprem.exceptions import (
+    BadParameterError,
+    NotFoundError,
+    UnknownError
+)
+
+try:
+    dataset = dataset_service.get_dataset(dataset_id="non-existent-id")
+except NotFoundError:
+    print("Dataset not found")
+except BadParameterError as e:
+    print(f"Invalid parameter: {e}")
+except UnknownError as e:
+    print(f"An unexpected error occurred: {e}")
+```
+
+
+## 🧪 Requirements
+
+- Python >= 3.7
+- requests >= 2.22.0
+- urllib3 >= 1.21.1
+- pydantic >= 1.8.0
+
+## 🤝 Contributing
+
+We welcome contributions to the Superb AI On-premise SDK! Here's how you can help:
+
+### Development Setup
+
+1. **Clone the repository:**
+```bash
+git clone https://github.com/Superb-AI-Suite/superb-ai-onprem-python.git
+cd superb-ai-onprem-python
+```
+
+2. **Install development dependencies:**
+```bash
+pip install -e ".[dev]"
+```
+
+### Contribution Guidelines
+
+- **Code Style:** Follow PEP 8 guidelines
+- **Testing:** Add tests for new features
+- **Documentation:** Update docstrings and README
+- **Pull Requests:** Use descriptive titles and include test results
+
+### Reporting Issues
+
+When reporting issues, please include:
+- SDK version (`spb_onprem.__version__`)
+- Python version
+- Error messages and stack traces
+- Minimal reproduction example
+- Expected vs actual behavior
+
+## 📞 Support
+
+### Community Support
+- **GitHub Issues:** [Report bugs and request features](https://github.com/Superb-AI-Suite/superb-ai-onprem-python/issues)
+- **Documentation:** [Official API documentation](https://docs.superb-ai.com)
+
+### Enterprise Support
+- **Technical Support:** Contact your Superb AI representative
+- **Custom Integration:** Professional services available
+- **Training:** SDK workshops and onboarding sessions
+
+### Quick Help
+
+**Common Issues:**
+- **Authentication errors:** Check config file format and credentials
+- **Connection issues:** Verify host URL and network connectivity  
+- **Import errors:** Ensure SDK is properly installed (`pip install superb-ai-onprem`)
+- **Performance issues:** Use appropriate pagination and filtering
+
+**Need immediate help?** Check our [FAQ section](https://docs.superb-ai.com/faq) or contact support.
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+**🚀 Ready to build something amazing?** Start with our [Quick Start Guide](#-quick-start) and explore the powerful features of Superb AI On-premise SDK!
+
+<div align="center">
+  <sub>Built with ❤️ by the <a href="https://superb-ai.com">Superb AI</a> team</sub>
+</div>
+

superb_ai_onprem-0.7.0/README.md

@@ -0,0 +1,258 @@
+# 🚀 Superb AI On-premise Python SDK
+
+![Python](https://img.shields.io/badge/python-3.7+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+![Version](https://img.shields.io/pypi/v/superb-ai-onprem.svg)
+
+**Superb AI On-premise Python SDK** is a comprehensive Python library that provides a simple and intuitive interface to interact with your on-premise Superb AI installation. Build powerful data management, annotation, and machine learning workflows with ease.
+
+## 🌟 Key Features
+
+- **🗂️ Dataset Management**: Create, organize, and manage your datasets
+- **📊 Data Operations**: Upload, annotate, and manipulate your data with powerful filtering
+- **🔍 Advanced Filtering**: Sophisticated filtering system for precise data queries  
+- **🏷️ Annotation Management**: Handle annotations and versions seamlessly
+- **📤 Export & Import**: Flexible data export and content management
+- **⚡ Activity Tracking**: Monitor and manage long-running tasks
+- **🔧 Slice Management**: Organize data into logical groups
+
+## 🔧 Installation
+
+### Step 1: Install the SDK
+
+Install the SDK using pip:
+
+```bash
+pip install superb-ai-onprem
+```
+
+**Requirements:**
+- Python 3.7 or higher
+- Active Superb AI On-premise installation
+
+> ⚠️ **Important**: The SDK will not work without this configuration file. Make sure to replace the values with your actual credentials from your Superb AI administrator.
+
+## 🚀 Quick Start
+
+Get up and running with Superb AI SDK in minutes:
+
+### Step 1: Authentication Setup
+
+First, set up your authentication credentials:
+
+**Option A: Config file (Recommended for local development)**
+```bash
+# Create config directory
+mkdir -p ~/.spb
+
+# Create config file
+cat > ~/.spb/onprem-config << EOF
+[default]
+host=https://your-superb-ai-host.com
+access_key=your-access-key
+access_key_secret=your-access-key-secret
+EOF
+```
+
+### Step 2: Your First Workflow
+
+```python
+from spb_onprem import DatasetService, DataService
+
+# Initialize services
+dataset_service = DatasetService()
+data_service = DataService()
+
+# 1. Find existing datasets
+datasets, cursor, total = dataset_service.get_dataset_list(length=10)
+print(f"📂 Found {total} datasets")
+
+if datasets:
+    # Use the first available dataset
+    dataset = datasets[0]
+    print(f"✅ Using dataset: {dataset.name} (ID: {dataset.id})")
+    
+    # 2. Get data list from the dataset
+    data_list, cursor, total = data_service.get_data_list(
+        dataset_id=dataset.id,
+        length=10
+    )
+    
+    print(f"📊 Dataset contains {total} data items")
+    
+    # 3. Display data information
+    for i, data in enumerate(data_list, 1):
+        print(f"  {i}. Key: {data.key}, Type: {data.type}, ID: {data.id}")
+        
+    if total > len(data_list):
+        print(f"  ... and {total - len(data_list)} more items")
+else:
+    print("❌ No datasets found. Please create a dataset first.")
+```
+
+**🎉 Congratulations!** You've successfully:
+- ✅ Connected to your Superb AI instance
+- ✅ Found existing datasets
+- ✅ Retrieved and displayed data information
+
+Ready for more? Check out our [comprehensive documentation](#-documentation) below!
+
+## 📚 Module Documentation
+
+### 🏗️ Core Modules
+
+Comprehensive guides for each SDK module with detailed examples and best practices:
+
+| Module | Purpose | Key Features | Documentation |
+|--------|---------|--------------|---------------|
+| **📁 Datasets** | Dataset lifecycle management | Create, organize, manage data collections | [📂 Dataset Guide](spb_onprem/datasets/README.md) |
+| **📊 Data** | Individual data management | CRUD operations, advanced filtering, annotations | [📊 Data Guide](spb_onprem/data/README.md) |
+| **🔪 Slices** | Data organization & filtering | Create filtered views, team collaboration | [� Slice Guide](spb_onprem/slices/README.md) |
+| **⚡ Activities** | Workflow & task management | Process automation, progress tracking | [⚡ Activity Guide](spb_onprem/activities/README.md) |
+| **📤 Exports** | Data & annotation export | Multi-format export (COCO, YOLO, Custom) | [📤 Export Guide](spb_onprem/exports/README.md) |
+
+### 🎯 Getting Started Paths
+
+Choose your learning path based on your use case:
+
+#### **📊 Data Management Workflow**
+1. Start with [� Datasets](spb_onprem/datasets/README.md) - Create and organize your data collections
+2. Then explore [📊 Data](spb_onprem/data/README.md) - Manage individual items and annotations  
+3. Use [🔪 Slices](spb_onprem/slices/README.md) - Organize data into logical groups
+
+#### **🚀 ML Pipeline Integration**
+1. Begin with [� Data](spb_onprem/data/README.md) - Understand data structure and filtering
+2. Configure [⚡ Activities](spb_onprem/activities/README.md) - Automate labeling and review workflows
+3. Setup [� Exports](spb_onprem/exports/README.md) - Export to ML training formats
+
+#### **👥 Team Collaboration**
+1. Setup [📁 Datasets](spb_onprem/datasets/README.md) - Organize team projects  
+2. Create [🔪 Slices](spb_onprem/slices/README.md) - Assign work to team members
+3. Implement [⚡ Activities](spb_onprem/activities/README.md) - Track progress and quality
+
+### 🔧 Advanced Features
+
+Each module includes:
+- **🎯 Quick Start Examples** - Get running immediately
+- **📋 Detailed Entity Documentation** - Pydantic models with comprehensive field descriptions  
+- **🔍 Advanced Usage Patterns** - Best practices and complex workflows
+- **🔗 Cross-Module Integration** - How modules work together
+- **⚡ Performance Tips** - Optimization recommendations
+
+### 🌐 Module Relationships
+
+```
+📁 Datasets (containers)
+├── 📊 Data (individual items) 
+│   ├── 🔪 Slices (filtered views)
+│   └── ⚡ Activities (processing workflows)
+└── 📤 Exports (output formats)
+```
+
+### ⚠️ Deprecated Modules
+
+| Module | Status | Migration Path |
+|--------|--------|----------------|
+| **ModelService** | 🚫 Deprecated | Use external ML frameworks |
+| **PredictionService** | 🚫 Deprecated | Use [📊 Data](spb_onprem/data/README.md) prediction entities |
+| **InferService** | 🚫 Deprecated | Use [⚡ Activities](spb_onprem/activities/README.md) for inference workflows |
+
+
+
+
+
+## ⚠️ Error Handling
+
+The SDK provides specific error types for different scenarios:
+
+```python
+from spb_onprem.exceptions import (
+    BadParameterError,
+    NotFoundError,
+    UnknownError
+)
+
+try:
+    dataset = dataset_service.get_dataset(dataset_id="non-existent-id")
+except NotFoundError:
+    print("Dataset not found")
+except BadParameterError as e:
+    print(f"Invalid parameter: {e}")
+except UnknownError as e:
+    print(f"An unexpected error occurred: {e}")
+```
+
+
+## 🧪 Requirements
+
+- Python >= 3.7
+- requests >= 2.22.0
+- urllib3 >= 1.21.1
+- pydantic >= 1.8.0
+
+## 🤝 Contributing
+
+We welcome contributions to the Superb AI On-premise SDK! Here's how you can help:
+
+### Development Setup
+
+1. **Clone the repository:**
+```bash
+git clone https://github.com/Superb-AI-Suite/superb-ai-onprem-python.git
+cd superb-ai-onprem-python
+```
+
+2. **Install development dependencies:**
+```bash
+pip install -e ".[dev]"
+```
+
+### Contribution Guidelines
+
+- **Code Style:** Follow PEP 8 guidelines
+- **Testing:** Add tests for new features
+- **Documentation:** Update docstrings and README
+- **Pull Requests:** Use descriptive titles and include test results
+
+### Reporting Issues
+
+When reporting issues, please include:
+- SDK version (`spb_onprem.__version__`)
+- Python version
+- Error messages and stack traces
+- Minimal reproduction example
+- Expected vs actual behavior
+
+## 📞 Support
+
+### Community Support
+- **GitHub Issues:** [Report bugs and request features](https://github.com/Superb-AI-Suite/superb-ai-onprem-python/issues)
+- **Documentation:** [Official API documentation](https://docs.superb-ai.com)
+
+### Enterprise Support
+- **Technical Support:** Contact your Superb AI representative
+- **Custom Integration:** Professional services available
+- **Training:** SDK workshops and onboarding sessions
+
+### Quick Help
+
+**Common Issues:**
+- **Authentication errors:** Check config file format and credentials
+- **Connection issues:** Verify host URL and network connectivity  
+- **Import errors:** Ensure SDK is properly installed (`pip install superb-ai-onprem`)
+- **Performance issues:** Use appropriate pagination and filtering
+
+**Need immediate help?** Check our [FAQ section](https://docs.superb-ai.com/faq) or contact support.
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+**🚀 Ready to build something amazing?** Start with our [Quick Start Guide](#-quick-start) and explore the powerful features of Superb AI On-premise SDK!
+
+<div align="center">
+  <sub>Built with ❤️ by the <a href="https://superb-ai.com">Superb AI</a> team</sub>
+</div>
+

{superb_ai_onprem-0.6.3 → superb_ai_onprem-0.7.0}/spb_onprem/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.6.3'
-__version_tuple__ = version_tuple = (0, 6, 3)
+__version__ = version = '0.7.0'
+__version_tuple__ = version_tuple = (0, 7, 0)
 
-__commit_id__ = commit_id = 'gfbbb04e5f'
+__commit_id__ = commit_id = 'g42451052f'