superb-ai-onprem 0.3.7__tar.gz → 1.6.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- superb_ai_onprem-1.6.0/.claude/settings.local.json +9 -0
- superb_ai_onprem-1.6.0/.github/workflows/tests.yml +42 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/.gitignore +5 -1
- superb_ai_onprem-1.6.0/PKG-INFO +323 -0
- superb_ai_onprem-1.6.0/README.md +296 -0
- superb_ai_onprem-1.6.0/requirements-test.txt +7 -0
- superb_ai_onprem-1.6.0/spb_onprem/__init__.py +184 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/_version.py +16 -3
- superb_ai_onprem-1.6.0/spb_onprem/activities/README.md +156 -0
- superb_ai_onprem-1.6.0/spb_onprem/activities/entities/activity.py +46 -0
- superb_ai_onprem-1.6.0/spb_onprem/activities/entities/activity_history.py +34 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/service.py +4 -5
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/base_service.py +74 -8
- superb_ai_onprem-1.6.0/spb_onprem/charts/README.md +538 -0
- superb_ai_onprem-1.6.0/spb_onprem/charts/__init__.py +29 -0
- superb_ai_onprem-1.6.0/spb_onprem/charts/factory.py +346 -0
- superb_ai_onprem-1.6.0/spb_onprem/contents/README.md +10 -0
- superb_ai_onprem-1.6.0/spb_onprem/contents/params/__init__.py +14 -0
- superb_ai_onprem-1.6.0/spb_onprem/contents/params/create.py +18 -0
- superb_ai_onprem-1.6.0/spb_onprem/contents/params/delete_content.py +10 -0
- superb_ai_onprem-1.6.0/spb_onprem/contents/params/get_download_url.py +8 -0
- superb_ai_onprem-1.6.0/spb_onprem/contents/params/get_file_download_url.py +10 -0
- superb_ai_onprem-1.6.0/spb_onprem/contents/params/get_upload_url.py +13 -0
- superb_ai_onprem-1.6.0/spb_onprem/contents/queries.py +79 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/contents/service.py +67 -8
- superb_ai_onprem-1.6.0/spb_onprem/data/README.md +245 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/entities/__init__.py +9 -2
- superb_ai_onprem-1.6.0/spb_onprem/data/entities/annotation.py +32 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/entities/comment.py +43 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/entities/data.py +44 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/entities/data_annotation_stats.py +9 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/entities/data_meta.py +3 -3
- superb_ai_onprem-1.6.0/spb_onprem/data/entities/data_slice.py +24 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/entities/frame.py +22 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/entities/prediction.py +15 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/entities/scene.py +16 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/enums/__init__.py +3 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/enums/data_meta_type.py +0 -1
- superb_ai_onprem-1.6.0/spb_onprem/data/enums/data_status.py +12 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/params/__init__.py +143 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/params/change_data_labeler.py +23 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/params/change_data_reviewer.py +23 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/params/change_data_status.py +23 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/create_data.py +3 -21
- superb_ai_onprem-1.6.0/spb_onprem/data/params/data_list.py +411 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/delete_data.py +1 -1
- superb_ai_onprem-1.6.0/spb_onprem/data/params/delete_slice_annotation_version.py +24 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/params/get_data_detail.py +14 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/insert_annotation_version.py +13 -6
- superb_ai_onprem-1.6.0/spb_onprem/data/params/insert_slice_annotation_version.py +39 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/params/update_annotation_version.py +39 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/update_data.py +17 -23
- superb_ai_onprem-1.6.0/spb_onprem/data/params/update_data_slice.py +46 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/params/update_frames.py +40 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/update_scene.py +10 -5
- superb_ai_onprem-1.6.0/spb_onprem/data/params/update_slice_annotation.py +24 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/params/update_slice_annotation_version.py +43 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/params/update_tags.py +38 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/upsert_data_meta.py +0 -12
- superb_ai_onprem-1.6.0/spb_onprem/data/queries.py +672 -0
- superb_ai_onprem-1.6.0/spb_onprem/data/service.py +883 -0
- superb_ai_onprem-1.6.0/spb_onprem/datasets/README.md +154 -0
- superb_ai_onprem-1.6.0/spb_onprem/datasets/entities/dataset.py +20 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/datasets/params/__init__.py +2 -0
- superb_ai_onprem-1.6.0/spb_onprem/datasets/params/delete_dataset.py +12 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/datasets/queries.py +28 -10
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/datasets/service.py +19 -1
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/entities.py +40 -4
- superb_ai_onprem-1.6.0/spb_onprem/inferences/DEPRECATED.md +23 -0
- superb_ai_onprem-1.6.0/spb_onprem/inferences/__init__.py +5 -0
- superb_ai_onprem-1.6.0/spb_onprem/inferences/service.py +56 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/__init__.py +8 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/entities.py +65 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/enums.py +28 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/params/__init__.py +23 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/params/create_model.py +78 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/params/create_training_report_item.py +32 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/params/delete_model.py +5 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/params/delete_training_report_item.py +20 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/params/get_model.py +21 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/params/get_models.py +23 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/params/models.py +24 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/params/update_model.py +98 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/params/update_training_report_item.py +39 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/queries.py +297 -0
- superb_ai_onprem-1.6.0/spb_onprem/models/service.py +335 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/README.md +435 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/__init__.py +25 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/entities/__init__.py +10 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/entities/analytics_report.py +22 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/entities/analytics_report_item.py +35 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/entities/analytics_report_page_info.py +14 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/params/__init__.py +29 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/params/analytics_report.py +17 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/params/analytics_reports.py +87 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/params/create_analytics_report.py +35 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/params/create_analytics_report_item.py +47 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/params/delete_analytics_report.py +17 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/params/delete_analytics_report_item.py +20 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/params/update_analytics_report.py +38 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/params/update_analytics_report_item.py +46 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/queries.py +237 -0
- superb_ai_onprem-1.6.0/spb_onprem/reports/service.py +408 -0
- superb_ai_onprem-1.6.0/spb_onprem/searches.py +90 -0
- superb_ai_onprem-1.6.0/spb_onprem/slices/README.md +239 -0
- superb_ai_onprem-1.6.0/spb_onprem/slices/entities/slice.py +20 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/slices/params/__init__.py +4 -0
- superb_ai_onprem-1.6.0/spb_onprem/slices/params/delete_slice.py +25 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/slices/queries.py +14 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/slices/service.py +49 -12
- superb_ai_onprem-1.6.0/spb_onprem/utils/__init__.py +4 -0
- superb_ai_onprem-1.6.0/superb_ai_onprem.egg-info/PKG-INFO +323 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/superb_ai_onprem.egg-info/SOURCES.txt +83 -20
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/tests/activities/test_params.py +2 -2
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/tests/activities/test_service.py +28 -38
- superb_ai_onprem-1.6.0/tests/contents/test_content_service.py +99 -0
- superb_ai_onprem-1.6.0/tests/contents/test_workflow.py +145 -0
- superb_ai_onprem-1.6.0/tests/data/test_data_service.py +106 -0
- superb_ai_onprem-1.6.0/tests/data/test_workflow.py +297 -0
- superb_ai_onprem-1.6.0/tests/datasets/__init__.py +1 -0
- superb_ai_onprem-1.6.0/tests/datasets/test_dataset_service.py +135 -0
- superb_ai_onprem-1.6.0/tests/models/__init__.py +1 -0
- superb_ai_onprem-1.6.0/tests/models/test_workflow.py +1320 -0
- superb_ai_onprem-1.6.0/tests/reports/__init__.py +0 -0
- superb_ai_onprem-1.6.0/tests/reports/test_workflow.py +358 -0
- superb_ai_onprem-1.6.0/tests/trainingreports/test_training_report_service.py +415 -0
- superb_ai_onprem-0.3.7/PKG-INFO +0 -246
- superb_ai_onprem-0.3.7/README.md +0 -219
- superb_ai_onprem-0.3.7/spb_onprem/__init__.py +0 -99
- superb_ai_onprem-0.3.7/spb_onprem/activities/entities/activity.py +0 -39
- superb_ai_onprem-0.3.7/spb_onprem/activities/entities/activity_history.py +0 -31
- superb_ai_onprem-0.3.7/spb_onprem/contents/queries.py +0 -61
- superb_ai_onprem-0.3.7/spb_onprem/data/entities/annotation.py +0 -25
- superb_ai_onprem-0.3.7/spb_onprem/data/entities/data.py +0 -28
- superb_ai_onprem-0.3.7/spb_onprem/data/entities/prediction.py +0 -13
- superb_ai_onprem-0.3.7/spb_onprem/data/entities/scene.py +0 -14
- superb_ai_onprem-0.3.7/spb_onprem/data/params/__init__.py +0 -59
- superb_ai_onprem-0.3.7/spb_onprem/data/params/data_list.py +0 -96
- superb_ai_onprem-0.3.7/spb_onprem/data/params/delete_prediction.py +0 -22
- superb_ai_onprem-0.3.7/spb_onprem/data/params/insert_prediction.py +0 -25
- superb_ai_onprem-0.3.7/spb_onprem/data/queries.py +0 -360
- superb_ai_onprem-0.3.7/spb_onprem/data/service.py +0 -541
- superb_ai_onprem-0.3.7/spb_onprem/datasets/entities/dataset.py +0 -14
- superb_ai_onprem-0.3.7/spb_onprem/exports/__init__.py +0 -9
- superb_ai_onprem-0.3.7/spb_onprem/exports/entities/__init__.py +0 -7
- superb_ai_onprem-0.3.7/spb_onprem/exports/entities/export.py +0 -27
- superb_ai_onprem-0.3.7/spb_onprem/exports/params/__init__.py +0 -19
- superb_ai_onprem-0.3.7/spb_onprem/exports/params/create_export.py +0 -85
- superb_ai_onprem-0.3.7/spb_onprem/exports/params/delete_export.py +0 -30
- superb_ai_onprem-0.3.7/spb_onprem/exports/params/export.py +0 -30
- superb_ai_onprem-0.3.7/spb_onprem/exports/params/exports.py +0 -74
- superb_ai_onprem-0.3.7/spb_onprem/exports/params/update_export.py +0 -98
- superb_ai_onprem-0.3.7/spb_onprem/exports/queries/get_exports.py +0 -97
- superb_ai_onprem-0.3.7/spb_onprem/exports/queries.py +0 -158
- superb_ai_onprem-0.3.7/spb_onprem/exports/service.py +0 -229
- superb_ai_onprem-0.3.7/spb_onprem/searches.py +0 -36
- superb_ai_onprem-0.3.7/spb_onprem/slices/entities/slice.py +0 -17
- superb_ai_onprem-0.3.7/superb_ai_onprem.egg-info/PKG-INFO +0 -246
- superb_ai_onprem-0.3.7/tests/exports/__init__.py +0 -1
- superb_ai_onprem-0.3.7/tests/exports/real_test.py +0 -130
- superb_ai_onprem-0.3.7/tests/exports/test_entities.py +0 -236
- superb_ai_onprem-0.3.7/tests/exports/test_integration.py +0 -191
- superb_ai_onprem-0.3.7/tests/exports/test_params.py +0 -332
- superb_ai_onprem-0.3.7/tests/exports/test_service.py +0 -406
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/.github/workflows/publish.yml +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/LICENSE +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/Pipfile +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/Pipfile.lock +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/pyproject.toml +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/setup.cfg +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/setup.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/entities/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/params/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/params/activities.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/params/activity.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/params/create_activity.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/params/delete_activity.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/params/get_activity_history.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/params/start_activity.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/params/update_activity.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/params/update_activity_history.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/activities/queries.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/base_model.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/base_types.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/contents/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/contents/entities/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/contents/entities/base_content.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/contents/entities/content.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/enums/data_type.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/enums/scene_type.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/data.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/delete_annotation_version.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/delete_scene.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/insert_data_to_slice.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/insert_scene.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/remove_data_from_slice.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/remove_data_meta.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/data/params/update_annotation.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/datasets/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/datasets/entities/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/datasets/params/create_dataset.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/datasets/params/dataset.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/datasets/params/datasets.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/datasets/params/update_dataset.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/exceptions.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/slices/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/slices/entities/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/slices/params/create_slice.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/slices/params/slice.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/slices/params/slices.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/slices/params/update_slice.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/users/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/users/entities/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/spb_onprem/users/entities/auth.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/superb_ai_onprem.egg-info/dependency_links.txt +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/superb_ai_onprem.egg-info/requires.txt +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/superb_ai_onprem.egg-info/top_level.txt +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/tests/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/tests/activities/__init__.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/tests/activities/real_test.py +0 -0
- {superb_ai_onprem-0.3.7 → superb_ai_onprem-1.6.0}/tests/activities/test_get_activity_history.py +0 -0
- /superb_ai_onprem-0.3.7/spb_onprem/slices/params/delete_slice.py → /superb_ai_onprem-1.6.0/tests/data/__init__.py +0 -0
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
name: CI - Tests
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
branches: [main]
|
|
8
|
+
|
|
9
|
+
concurrency:
|
|
10
|
+
group: ${{ github.workflow }}-${{ github.ref }}
|
|
11
|
+
cancel-in-progress: true
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
tests:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
|
|
17
|
+
steps:
|
|
18
|
+
- name: Checkout
|
|
19
|
+
uses: actions/checkout@v4
|
|
20
|
+
|
|
21
|
+
- name: Set up Python 3.11
|
|
22
|
+
uses: actions/setup-python@v5
|
|
23
|
+
with:
|
|
24
|
+
python-version: '3.11'
|
|
25
|
+
|
|
26
|
+
- name: Cache pip dependencies
|
|
27
|
+
uses: actions/cache@v4
|
|
28
|
+
with:
|
|
29
|
+
path: ~/.cache/pip
|
|
30
|
+
key: pip-${{ runner.os }}-3.11-${{ hashFiles('setup.py', 'requirements-test.txt') }}
|
|
31
|
+
restore-keys: |
|
|
32
|
+
pip-${{ runner.os }}-3.11-
|
|
33
|
+
|
|
34
|
+
- name: Install dependencies
|
|
35
|
+
run: |
|
|
36
|
+
python -m pip install --upgrade pip
|
|
37
|
+
pip install -e .
|
|
38
|
+
pip install -r requirements-test.txt
|
|
39
|
+
|
|
40
|
+
- name: Run tests
|
|
41
|
+
run: |
|
|
42
|
+
pytest tests/ -v --ignore=tests/activities/real_test.py --ignore=tests/exports/real_test.py
|
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: superb-ai-onprem
|
|
3
|
+
Version: 1.6.0
|
|
4
|
+
Summary: Python SDK for Superb AI On-premise
|
|
5
|
+
Home-page: https://github.com/Superb-AI-Suite/superb-ai-onprem-python
|
|
6
|
+
Author: Superb AI
|
|
7
|
+
Author-email: support@superb-ai.com
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
10
|
+
Classifier: Operating System :: OS Independent
|
|
11
|
+
Requires-Python: >=3.8
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
Requires-Dist: requests>=2.22.0
|
|
15
|
+
Requires-Dist: urllib3>=1.21.1
|
|
16
|
+
Requires-Dist: pydantic>=1.8.0
|
|
17
|
+
Dynamic: author
|
|
18
|
+
Dynamic: author-email
|
|
19
|
+
Dynamic: classifier
|
|
20
|
+
Dynamic: description
|
|
21
|
+
Dynamic: description-content-type
|
|
22
|
+
Dynamic: home-page
|
|
23
|
+
Dynamic: license-file
|
|
24
|
+
Dynamic: requires-dist
|
|
25
|
+
Dynamic: requires-python
|
|
26
|
+
Dynamic: summary
|
|
27
|
+
|
|
28
|
+
# 🚀 Superb AI On-premise Python SDK
|
|
29
|
+
|
|
30
|
+

|
|
31
|
+

|
|
32
|
+

|
|
33
|
+
|
|
34
|
+
**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.
|
|
35
|
+
|
|
36
|
+
## 🌟 Key Features
|
|
37
|
+
|
|
38
|
+
- **🗂️ Dataset Management**: Create, organize, and manage your datasets
|
|
39
|
+
- **📊 Data Operations**: Upload, annotate, and manipulate your data with powerful filtering
|
|
40
|
+
- **🔍 Advanced Filtering**: Sophisticated filtering system for precise data queries
|
|
41
|
+
- **🏷️ Annotation Management**: Handle annotations and versions seamlessly
|
|
42
|
+
- **📁 Content Management**: Upload and manage file content
|
|
43
|
+
- **⚡ Activity Tracking**: Monitor and manage long-running tasks
|
|
44
|
+
- **🔧 Slice Management**: Organize data into logical groups
|
|
45
|
+
- **🤖 Model Tracking**: Register and monitor ML model performance
|
|
46
|
+
- **📈 Analytics Reports**: Generate and visualize dataset analytics
|
|
47
|
+
|
|
48
|
+
## 🔧 Installation
|
|
49
|
+
|
|
50
|
+
### Step 1: Install the SDK
|
|
51
|
+
|
|
52
|
+
Install the SDK using pip:
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
pip install superb-ai-onprem
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**Requirements:**
|
|
59
|
+
- Python 3.7 or higher
|
|
60
|
+
- Active Superb AI On-premise installation
|
|
61
|
+
|
|
62
|
+
> ⚠️ **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.
|
|
63
|
+
|
|
64
|
+
## 🚀 Quick Start
|
|
65
|
+
|
|
66
|
+
Get up and running with Superb AI SDK in minutes:
|
|
67
|
+
|
|
68
|
+
### Step 1: Authentication Setup
|
|
69
|
+
|
|
70
|
+
First, set up your authentication credentials:
|
|
71
|
+
|
|
72
|
+
**Option A: Config file (Recommended for local development)**
|
|
73
|
+
```bash
|
|
74
|
+
# Create config directory
|
|
75
|
+
mkdir -p ~/.spb
|
|
76
|
+
|
|
77
|
+
# Create config file
|
|
78
|
+
cat > ~/.spb/onprem-config << EOF
|
|
79
|
+
[default]
|
|
80
|
+
host=https://your-superb-ai-host.com
|
|
81
|
+
access_key=your-access-key
|
|
82
|
+
access_key_secret=your-access-key-secret
|
|
83
|
+
EOF
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Step 2: Your First Workflow
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
from spb_onprem import DatasetService, DataService, ModelService, ReportService
|
|
90
|
+
|
|
91
|
+
# Initialize services
|
|
92
|
+
dataset_service = DatasetService()
|
|
93
|
+
data_service = DataService()
|
|
94
|
+
model_service = ModelService()
|
|
95
|
+
report_service = ReportService()
|
|
96
|
+
|
|
97
|
+
# 1. Find existing datasets
|
|
98
|
+
datasets, cursor, total = dataset_service.get_datasets(length=10)
|
|
99
|
+
print(f"📂 Found {total} datasets")
|
|
100
|
+
|
|
101
|
+
if datasets:
|
|
102
|
+
# Use the first available dataset
|
|
103
|
+
dataset = datasets[0]
|
|
104
|
+
print(f"✅ Using dataset: {dataset.name} (ID: {dataset.id})")
|
|
105
|
+
|
|
106
|
+
# 2. Get data list from the dataset
|
|
107
|
+
data_list, cursor, total = data_service.get_data_list(
|
|
108
|
+
dataset_id=dataset.id,
|
|
109
|
+
length=10
|
|
110
|
+
)
|
|
111
|
+
|
|
112
|
+
print(f"📊 Dataset contains {total} data items")
|
|
113
|
+
|
|
114
|
+
# 3. Display data information
|
|
115
|
+
for i, data in enumerate(data_list, 1):
|
|
116
|
+
print(f" {i}. Key: {data.key}, Type: {data.type}, ID: {data.id}")
|
|
117
|
+
|
|
118
|
+
if total > len(data_list):
|
|
119
|
+
print(f" ... and {total - len(data_list)} more items")
|
|
120
|
+
|
|
121
|
+
# 4. Check models in the dataset
|
|
122
|
+
models, _, model_count = model_service.get_models(
|
|
123
|
+
dataset_id=dataset.id,
|
|
124
|
+
length=5
|
|
125
|
+
)
|
|
126
|
+
|
|
127
|
+
if model_count > 0:
|
|
128
|
+
print(f"\n🤖 Found {model_count} models")
|
|
129
|
+
for model in models:
|
|
130
|
+
print(f" - {model.name} ({model.baseline_model})")
|
|
131
|
+
|
|
132
|
+
# 5. Check analytics reports
|
|
133
|
+
reports, _, report_count = report_service.get_analytics_reports(
|
|
134
|
+
dataset_id=dataset.id,
|
|
135
|
+
length=5
|
|
136
|
+
)
|
|
137
|
+
|
|
138
|
+
if report_count > 0:
|
|
139
|
+
print(f"\n📈 Found {report_count} analytics reports")
|
|
140
|
+
for report in reports:
|
|
141
|
+
print(f" - {report.title}")
|
|
142
|
+
else:
|
|
143
|
+
print("❌ No datasets found. Please create a dataset first.")
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
**🎉 Congratulations!** You've successfully:
|
|
147
|
+
- ✅ Connected to your Superb AI instance
|
|
148
|
+
- ✅ Found existing datasets
|
|
149
|
+
- ✅ Retrieved and displayed data information
|
|
150
|
+
- ✅ Explored models and reports
|
|
151
|
+
|
|
152
|
+
Ready for more? Check out our [comprehensive documentation](#-documentation) below!
|
|
153
|
+
|
|
154
|
+
## 📚 Module Documentation
|
|
155
|
+
|
|
156
|
+
### 🏗️ Core Modules
|
|
157
|
+
|
|
158
|
+
Comprehensive guides for each SDK module with detailed examples and best practices:
|
|
159
|
+
|
|
160
|
+
| Module | Purpose | Key Features | Documentation |
|
|
161
|
+
|--------|---------|--------------|---------------|
|
|
162
|
+
| **📁 Datasets** | Dataset lifecycle management | Create, organize, manage data collections | [📂 Dataset Guide](spb_onprem/datasets/README.md) |
|
|
163
|
+
| **📊 Data** | Individual data management | CRUD operations, advanced filtering, annotations | [📊 Data Guide](spb_onprem/data/README.md) |
|
|
164
|
+
| **🔪 Slices** | Data organization & filtering | Create filtered views, team collaboration | [🔪 Slice Guide](spb_onprem/slices/README.md) |
|
|
165
|
+
| **⚡ Activities** | Workflow & task management | Process automation, progress tracking | [⚡ Activity Guide](spb_onprem/activities/README.md) |
|
|
166
|
+
| **🤖 Models** | ML model management | Track models, training configs, performance metrics | [🤖 Model Guide](spb_onprem/models/README.md) |
|
|
167
|
+
| **📈 Reports** | Analytics & visualization | Create reports, charts, dashboards | [📈 Report Guide](spb_onprem/reports/README.md) |
|
|
168
|
+
| **📊 Charts** | Chart data factory | Generate training metrics visualizations (9 chart types) | [📊 Chart Guide](spb_onprem/charts/README.md) |
|
|
169
|
+
|
|
170
|
+
### 🎯 Getting Started Paths
|
|
171
|
+
|
|
172
|
+
Choose your learning path based on your use case:
|
|
173
|
+
|
|
174
|
+
#### **📊 Data Management Workflow**
|
|
175
|
+
1. Start with [📁 Datasets](spb_onprem/datasets/README.md) - Create and organize your data collections
|
|
176
|
+
2. Then explore [📊 Data](spb_onprem/data/README.md) - Manage individual items and annotations
|
|
177
|
+
3. Use [🔪 Slices](spb_onprem/slices/README.md) - Organize data into logical groups
|
|
178
|
+
|
|
179
|
+
#### **🚀 ML Pipeline Integration**
|
|
180
|
+
1. Begin with [📊 Data](spb_onprem/data/README.md) - Understand data structure and filtering
|
|
181
|
+
2. Configure [⚡ Activities](spb_onprem/activities/README.md) - Automate labeling and review workflows
|
|
182
|
+
3. Track with [🤖 Models](spb_onprem/models/README.md) - Register and monitor model performance
|
|
183
|
+
4. Create visualizations with [📊 Charts](spb_onprem/charts/README.md) - Generate training metrics charts
|
|
184
|
+
5. Build dashboards with [📈 Reports](spb_onprem/reports/README.md) - Compile analytics reports
|
|
185
|
+
|
|
186
|
+
#### **👥 Team Collaboration**
|
|
187
|
+
1. Setup [📁 Datasets](spb_onprem/datasets/README.md) - Organize team projects
|
|
188
|
+
2. Create [🔪 Slices](spb_onprem/slices/README.md) - Assign work to team members
|
|
189
|
+
3. Implement [⚡ Activities](spb_onprem/activities/README.md) - Track progress and quality
|
|
190
|
+
|
|
191
|
+
### 🔧 Advanced Features
|
|
192
|
+
|
|
193
|
+
Each module includes:
|
|
194
|
+
- **🎯 Quick Start Examples** - Get running immediately
|
|
195
|
+
- **📋 Detailed Entity Documentation** - Pydantic models with comprehensive field descriptions
|
|
196
|
+
- **🔍 Advanced Usage Patterns** - Best practices and complex workflows
|
|
197
|
+
- **🔗 Cross-Module Integration** - How modules work together
|
|
198
|
+
- **⚡ Performance Tips** - Optimization recommendations
|
|
199
|
+
|
|
200
|
+
### 🌐 Module Relationships
|
|
201
|
+
|
|
202
|
+
```
|
|
203
|
+
📁 Datasets (containers)
|
|
204
|
+
├── 📊 Data (individual items)
|
|
205
|
+
│ ├── 🔪 Slices (filtered views)
|
|
206
|
+
│ │ └── 🤖 Models (training configs)
|
|
207
|
+
│ └── ⚡ Activities (processing workflows)
|
|
208
|
+
└── 📈 Reports (analytics & visualizations)
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### 🆕 New Modules (v2.0+)
|
|
212
|
+
|
|
213
|
+
| Module | Added | Status | Description |
|
|
214
|
+
|--------|-------|--------|-------------|
|
|
215
|
+
| **🤖 Models** | v2.0 | ✅ Stable | ML model lifecycle management and performance tracking |
|
|
216
|
+
| **📈 Reports** | v2.0 | ✅ Stable | Analytics reports and visualization dashboards |
|
|
217
|
+
| **📊 Charts** | v2.0 | ✅ Stable | Chart data factory with 9 chart types for training metrics visualization |
|
|
218
|
+
|
|
219
|
+
### ⚠️ Deprecated Modules
|
|
220
|
+
|
|
221
|
+
| Module | Status | Migration Path |
|
|
222
|
+
|--------|--------|----------------|
|
|
223
|
+
| **InferService** | 🚫 Deprecated | Use [🤖 Models](spb_onprem/models/README.md) for model management and [⚡ Activities](spb_onprem/activities/README.md) for inference workflows |
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
## ⚠️ Error Handling
|
|
230
|
+
|
|
231
|
+
The SDK provides specific error types for different scenarios:
|
|
232
|
+
|
|
233
|
+
```python
|
|
234
|
+
from spb_onprem.exceptions import (
|
|
235
|
+
BadParameterError,
|
|
236
|
+
NotFoundError,
|
|
237
|
+
UnknownError
|
|
238
|
+
)
|
|
239
|
+
|
|
240
|
+
try:
|
|
241
|
+
dataset = dataset_service.get_dataset(dataset_id="non-existent-id")
|
|
242
|
+
except NotFoundError:
|
|
243
|
+
print("Dataset not found")
|
|
244
|
+
except BadParameterError as e:
|
|
245
|
+
print(f"Invalid parameter: {e}")
|
|
246
|
+
except UnknownError as e:
|
|
247
|
+
print(f"An unexpected error occurred: {e}")
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
## 🧪 Requirements
|
|
252
|
+
|
|
253
|
+
- Python >= 3.7
|
|
254
|
+
- requests >= 2.22.0
|
|
255
|
+
- urllib3 >= 1.21.1
|
|
256
|
+
- pydantic >= 1.8.0
|
|
257
|
+
|
|
258
|
+
## 🤝 Contributing
|
|
259
|
+
|
|
260
|
+
We welcome contributions to the Superb AI On-premise SDK! Here's how you can help:
|
|
261
|
+
|
|
262
|
+
### Development Setup
|
|
263
|
+
|
|
264
|
+
1. **Clone the repository:**
|
|
265
|
+
```bash
|
|
266
|
+
git clone https://github.com/Superb-AI-Suite/superb-ai-onprem-python.git
|
|
267
|
+
cd superb-ai-onprem-python
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
2. **Install development dependencies:**
|
|
271
|
+
```bash
|
|
272
|
+
pip install -e ".[dev]"
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
### Contribution Guidelines
|
|
276
|
+
|
|
277
|
+
- **Code Style:** Follow PEP 8 guidelines
|
|
278
|
+
- **Testing:** Add tests for new features
|
|
279
|
+
- **Documentation:** Update docstrings and README
|
|
280
|
+
- **Pull Requests:** Use descriptive titles and include test results
|
|
281
|
+
|
|
282
|
+
### Reporting Issues
|
|
283
|
+
|
|
284
|
+
When reporting issues, please include:
|
|
285
|
+
- SDK version (`spb_onprem.__version__`)
|
|
286
|
+
- Python version
|
|
287
|
+
- Error messages and stack traces
|
|
288
|
+
- Minimal reproduction example
|
|
289
|
+
- Expected vs actual behavior
|
|
290
|
+
|
|
291
|
+
## 📞 Support
|
|
292
|
+
|
|
293
|
+
### Community Support
|
|
294
|
+
- **GitHub Issues:** [Report bugs and request features](https://github.com/Superb-AI-Suite/superb-ai-onprem-python/issues)
|
|
295
|
+
- **Documentation:** [Official API documentation](https://docs.superb-ai.com)
|
|
296
|
+
|
|
297
|
+
### Enterprise Support
|
|
298
|
+
- **Technical Support:** Contact your Superb AI representative
|
|
299
|
+
- **Custom Integration:** Professional services available
|
|
300
|
+
- **Training:** SDK workshops and onboarding sessions
|
|
301
|
+
|
|
302
|
+
### Quick Help
|
|
303
|
+
|
|
304
|
+
**Common Issues:**
|
|
305
|
+
- **Authentication errors:** Check config file format and credentials
|
|
306
|
+
- **Connection issues:** Verify host URL and network connectivity
|
|
307
|
+
- **Import errors:** Ensure SDK is properly installed (`pip install superb-ai-onprem`)
|
|
308
|
+
- **Performance issues:** Use appropriate pagination and filtering
|
|
309
|
+
|
|
310
|
+
**Need immediate help?** Check our [FAQ section](https://docs.superb-ai.com/faq) or contact support.
|
|
311
|
+
|
|
312
|
+
## 📄 License
|
|
313
|
+
|
|
314
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
315
|
+
|
|
316
|
+
---
|
|
317
|
+
|
|
318
|
+
**🚀 Ready to build something amazing?** Start with our [Quick Start Guide](#-quick-start) and explore the powerful features of Superb AI On-premise SDK!
|
|
319
|
+
|
|
320
|
+
<div align="center">
|
|
321
|
+
<sub>Built with ❤️ by the <a href="https://superb-ai.com">Superb AI</a> team</sub>
|
|
322
|
+
</div>
|
|
323
|
+
|
|
@@ -0,0 +1,296 @@
|
|
|
1
|
+
# 🚀 Superb AI On-premise Python SDK
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+

|
|
5
|
+

|
|
6
|
+
|
|
7
|
+
**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.
|
|
8
|
+
|
|
9
|
+
## 🌟 Key Features
|
|
10
|
+
|
|
11
|
+
- **🗂️ Dataset Management**: Create, organize, and manage your datasets
|
|
12
|
+
- **📊 Data Operations**: Upload, annotate, and manipulate your data with powerful filtering
|
|
13
|
+
- **🔍 Advanced Filtering**: Sophisticated filtering system for precise data queries
|
|
14
|
+
- **🏷️ Annotation Management**: Handle annotations and versions seamlessly
|
|
15
|
+
- **📁 Content Management**: Upload and manage file content
|
|
16
|
+
- **⚡ Activity Tracking**: Monitor and manage long-running tasks
|
|
17
|
+
- **🔧 Slice Management**: Organize data into logical groups
|
|
18
|
+
- **🤖 Model Tracking**: Register and monitor ML model performance
|
|
19
|
+
- **📈 Analytics Reports**: Generate and visualize dataset analytics
|
|
20
|
+
|
|
21
|
+
## 🔧 Installation
|
|
22
|
+
|
|
23
|
+
### Step 1: Install the SDK
|
|
24
|
+
|
|
25
|
+
Install the SDK using pip:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
pip install superb-ai-onprem
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**Requirements:**
|
|
32
|
+
- Python 3.7 or higher
|
|
33
|
+
- Active Superb AI On-premise installation
|
|
34
|
+
|
|
35
|
+
> ⚠️ **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.
|
|
36
|
+
|
|
37
|
+
## 🚀 Quick Start
|
|
38
|
+
|
|
39
|
+
Get up and running with Superb AI SDK in minutes:
|
|
40
|
+
|
|
41
|
+
### Step 1: Authentication Setup
|
|
42
|
+
|
|
43
|
+
First, set up your authentication credentials:
|
|
44
|
+
|
|
45
|
+
**Option A: Config file (Recommended for local development)**
|
|
46
|
+
```bash
|
|
47
|
+
# Create config directory
|
|
48
|
+
mkdir -p ~/.spb
|
|
49
|
+
|
|
50
|
+
# Create config file
|
|
51
|
+
cat > ~/.spb/onprem-config << EOF
|
|
52
|
+
[default]
|
|
53
|
+
host=https://your-superb-ai-host.com
|
|
54
|
+
access_key=your-access-key
|
|
55
|
+
access_key_secret=your-access-key-secret
|
|
56
|
+
EOF
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Step 2: Your First Workflow
|
|
60
|
+
|
|
61
|
+
```python
|
|
62
|
+
from spb_onprem import DatasetService, DataService, ModelService, ReportService
|
|
63
|
+
|
|
64
|
+
# Initialize services
|
|
65
|
+
dataset_service = DatasetService()
|
|
66
|
+
data_service = DataService()
|
|
67
|
+
model_service = ModelService()
|
|
68
|
+
report_service = ReportService()
|
|
69
|
+
|
|
70
|
+
# 1. Find existing datasets
|
|
71
|
+
datasets, cursor, total = dataset_service.get_datasets(length=10)
|
|
72
|
+
print(f"📂 Found {total} datasets")
|
|
73
|
+
|
|
74
|
+
if datasets:
|
|
75
|
+
# Use the first available dataset
|
|
76
|
+
dataset = datasets[0]
|
|
77
|
+
print(f"✅ Using dataset: {dataset.name} (ID: {dataset.id})")
|
|
78
|
+
|
|
79
|
+
# 2. Get data list from the dataset
|
|
80
|
+
data_list, cursor, total = data_service.get_data_list(
|
|
81
|
+
dataset_id=dataset.id,
|
|
82
|
+
length=10
|
|
83
|
+
)
|
|
84
|
+
|
|
85
|
+
print(f"📊 Dataset contains {total} data items")
|
|
86
|
+
|
|
87
|
+
# 3. Display data information
|
|
88
|
+
for i, data in enumerate(data_list, 1):
|
|
89
|
+
print(f" {i}. Key: {data.key}, Type: {data.type}, ID: {data.id}")
|
|
90
|
+
|
|
91
|
+
if total > len(data_list):
|
|
92
|
+
print(f" ... and {total - len(data_list)} more items")
|
|
93
|
+
|
|
94
|
+
# 4. Check models in the dataset
|
|
95
|
+
models, _, model_count = model_service.get_models(
|
|
96
|
+
dataset_id=dataset.id,
|
|
97
|
+
length=5
|
|
98
|
+
)
|
|
99
|
+
|
|
100
|
+
if model_count > 0:
|
|
101
|
+
print(f"\n🤖 Found {model_count} models")
|
|
102
|
+
for model in models:
|
|
103
|
+
print(f" - {model.name} ({model.baseline_model})")
|
|
104
|
+
|
|
105
|
+
# 5. Check analytics reports
|
|
106
|
+
reports, _, report_count = report_service.get_analytics_reports(
|
|
107
|
+
dataset_id=dataset.id,
|
|
108
|
+
length=5
|
|
109
|
+
)
|
|
110
|
+
|
|
111
|
+
if report_count > 0:
|
|
112
|
+
print(f"\n📈 Found {report_count} analytics reports")
|
|
113
|
+
for report in reports:
|
|
114
|
+
print(f" - {report.title}")
|
|
115
|
+
else:
|
|
116
|
+
print("❌ No datasets found. Please create a dataset first.")
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
**🎉 Congratulations!** You've successfully:
|
|
120
|
+
- ✅ Connected to your Superb AI instance
|
|
121
|
+
- ✅ Found existing datasets
|
|
122
|
+
- ✅ Retrieved and displayed data information
|
|
123
|
+
- ✅ Explored models and reports
|
|
124
|
+
|
|
125
|
+
Ready for more? Check out our [comprehensive documentation](#-documentation) below!
|
|
126
|
+
|
|
127
|
+
## 📚 Module Documentation
|
|
128
|
+
|
|
129
|
+
### 🏗️ Core Modules
|
|
130
|
+
|
|
131
|
+
Comprehensive guides for each SDK module with detailed examples and best practices:
|
|
132
|
+
|
|
133
|
+
| Module | Purpose | Key Features | Documentation |
|
|
134
|
+
|--------|---------|--------------|---------------|
|
|
135
|
+
| **📁 Datasets** | Dataset lifecycle management | Create, organize, manage data collections | [📂 Dataset Guide](spb_onprem/datasets/README.md) |
|
|
136
|
+
| **📊 Data** | Individual data management | CRUD operations, advanced filtering, annotations | [📊 Data Guide](spb_onprem/data/README.md) |
|
|
137
|
+
| **🔪 Slices** | Data organization & filtering | Create filtered views, team collaboration | [🔪 Slice Guide](spb_onprem/slices/README.md) |
|
|
138
|
+
| **⚡ Activities** | Workflow & task management | Process automation, progress tracking | [⚡ Activity Guide](spb_onprem/activities/README.md) |
|
|
139
|
+
| **🤖 Models** | ML model management | Track models, training configs, performance metrics | [🤖 Model Guide](spb_onprem/models/README.md) |
|
|
140
|
+
| **📈 Reports** | Analytics & visualization | Create reports, charts, dashboards | [📈 Report Guide](spb_onprem/reports/README.md) |
|
|
141
|
+
| **📊 Charts** | Chart data factory | Generate training metrics visualizations (9 chart types) | [📊 Chart Guide](spb_onprem/charts/README.md) |
|
|
142
|
+
|
|
143
|
+
### 🎯 Getting Started Paths
|
|
144
|
+
|
|
145
|
+
Choose your learning path based on your use case:
|
|
146
|
+
|
|
147
|
+
#### **📊 Data Management Workflow**
|
|
148
|
+
1. Start with [📁 Datasets](spb_onprem/datasets/README.md) - Create and organize your data collections
|
|
149
|
+
2. Then explore [📊 Data](spb_onprem/data/README.md) - Manage individual items and annotations
|
|
150
|
+
3. Use [🔪 Slices](spb_onprem/slices/README.md) - Organize data into logical groups
|
|
151
|
+
|
|
152
|
+
#### **🚀 ML Pipeline Integration**
|
|
153
|
+
1. Begin with [📊 Data](spb_onprem/data/README.md) - Understand data structure and filtering
|
|
154
|
+
2. Configure [⚡ Activities](spb_onprem/activities/README.md) - Automate labeling and review workflows
|
|
155
|
+
3. Track with [🤖 Models](spb_onprem/models/README.md) - Register and monitor model performance
|
|
156
|
+
4. Create visualizations with [📊 Charts](spb_onprem/charts/README.md) - Generate training metrics charts
|
|
157
|
+
5. Build dashboards with [📈 Reports](spb_onprem/reports/README.md) - Compile analytics reports
|
|
158
|
+
|
|
159
|
+
#### **👥 Team Collaboration**
|
|
160
|
+
1. Setup [📁 Datasets](spb_onprem/datasets/README.md) - Organize team projects
|
|
161
|
+
2. Create [🔪 Slices](spb_onprem/slices/README.md) - Assign work to team members
|
|
162
|
+
3. Implement [⚡ Activities](spb_onprem/activities/README.md) - Track progress and quality
|
|
163
|
+
|
|
164
|
+
### 🔧 Advanced Features
|
|
165
|
+
|
|
166
|
+
Each module includes:
|
|
167
|
+
- **🎯 Quick Start Examples** - Get running immediately
|
|
168
|
+
- **📋 Detailed Entity Documentation** - Pydantic models with comprehensive field descriptions
|
|
169
|
+
- **🔍 Advanced Usage Patterns** - Best practices and complex workflows
|
|
170
|
+
- **🔗 Cross-Module Integration** - How modules work together
|
|
171
|
+
- **⚡ Performance Tips** - Optimization recommendations
|
|
172
|
+
|
|
173
|
+
### 🌐 Module Relationships
|
|
174
|
+
|
|
175
|
+
```
|
|
176
|
+
📁 Datasets (containers)
|
|
177
|
+
├── 📊 Data (individual items)
|
|
178
|
+
│ ├── 🔪 Slices (filtered views)
|
|
179
|
+
│ │ └── 🤖 Models (training configs)
|
|
180
|
+
│ └── ⚡ Activities (processing workflows)
|
|
181
|
+
└── 📈 Reports (analytics & visualizations)
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### 🆕 New Modules (v2.0+)
|
|
185
|
+
|
|
186
|
+
| Module | Added | Status | Description |
|
|
187
|
+
|--------|-------|--------|-------------|
|
|
188
|
+
| **🤖 Models** | v2.0 | ✅ Stable | ML model lifecycle management and performance tracking |
|
|
189
|
+
| **📈 Reports** | v2.0 | ✅ Stable | Analytics reports and visualization dashboards |
|
|
190
|
+
| **📊 Charts** | v2.0 | ✅ Stable | Chart data factory with 9 chart types for training metrics visualization |
|
|
191
|
+
|
|
192
|
+
### ⚠️ Deprecated Modules
|
|
193
|
+
|
|
194
|
+
| Module | Status | Migration Path |
|
|
195
|
+
|--------|--------|----------------|
|
|
196
|
+
| **InferService** | 🚫 Deprecated | Use [🤖 Models](spb_onprem/models/README.md) for model management and [⚡ Activities](spb_onprem/activities/README.md) for inference workflows |
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
## ⚠️ Error Handling
|
|
203
|
+
|
|
204
|
+
The SDK provides specific error types for different scenarios:
|
|
205
|
+
|
|
206
|
+
```python
|
|
207
|
+
from spb_onprem.exceptions import (
|
|
208
|
+
BadParameterError,
|
|
209
|
+
NotFoundError,
|
|
210
|
+
UnknownError
|
|
211
|
+
)
|
|
212
|
+
|
|
213
|
+
try:
|
|
214
|
+
dataset = dataset_service.get_dataset(dataset_id="non-existent-id")
|
|
215
|
+
except NotFoundError:
|
|
216
|
+
print("Dataset not found")
|
|
217
|
+
except BadParameterError as e:
|
|
218
|
+
print(f"Invalid parameter: {e}")
|
|
219
|
+
except UnknownError as e:
|
|
220
|
+
print(f"An unexpected error occurred: {e}")
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
## 🧪 Requirements
|
|
225
|
+
|
|
226
|
+
- Python >= 3.7
|
|
227
|
+
- requests >= 2.22.0
|
|
228
|
+
- urllib3 >= 1.21.1
|
|
229
|
+
- pydantic >= 1.8.0
|
|
230
|
+
|
|
231
|
+
## 🤝 Contributing
|
|
232
|
+
|
|
233
|
+
We welcome contributions to the Superb AI On-premise SDK! Here's how you can help:
|
|
234
|
+
|
|
235
|
+
### Development Setup
|
|
236
|
+
|
|
237
|
+
1. **Clone the repository:**
|
|
238
|
+
```bash
|
|
239
|
+
git clone https://github.com/Superb-AI-Suite/superb-ai-onprem-python.git
|
|
240
|
+
cd superb-ai-onprem-python
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
2. **Install development dependencies:**
|
|
244
|
+
```bash
|
|
245
|
+
pip install -e ".[dev]"
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
### Contribution Guidelines
|
|
249
|
+
|
|
250
|
+
- **Code Style:** Follow PEP 8 guidelines
|
|
251
|
+
- **Testing:** Add tests for new features
|
|
252
|
+
- **Documentation:** Update docstrings and README
|
|
253
|
+
- **Pull Requests:** Use descriptive titles and include test results
|
|
254
|
+
|
|
255
|
+
### Reporting Issues
|
|
256
|
+
|
|
257
|
+
When reporting issues, please include:
|
|
258
|
+
- SDK version (`spb_onprem.__version__`)
|
|
259
|
+
- Python version
|
|
260
|
+
- Error messages and stack traces
|
|
261
|
+
- Minimal reproduction example
|
|
262
|
+
- Expected vs actual behavior
|
|
263
|
+
|
|
264
|
+
## 📞 Support
|
|
265
|
+
|
|
266
|
+
### Community Support
|
|
267
|
+
- **GitHub Issues:** [Report bugs and request features](https://github.com/Superb-AI-Suite/superb-ai-onprem-python/issues)
|
|
268
|
+
- **Documentation:** [Official API documentation](https://docs.superb-ai.com)
|
|
269
|
+
|
|
270
|
+
### Enterprise Support
|
|
271
|
+
- **Technical Support:** Contact your Superb AI representative
|
|
272
|
+
- **Custom Integration:** Professional services available
|
|
273
|
+
- **Training:** SDK workshops and onboarding sessions
|
|
274
|
+
|
|
275
|
+
### Quick Help
|
|
276
|
+
|
|
277
|
+
**Common Issues:**
|
|
278
|
+
- **Authentication errors:** Check config file format and credentials
|
|
279
|
+
- **Connection issues:** Verify host URL and network connectivity
|
|
280
|
+
- **Import errors:** Ensure SDK is properly installed (`pip install superb-ai-onprem`)
|
|
281
|
+
- **Performance issues:** Use appropriate pagination and filtering
|
|
282
|
+
|
|
283
|
+
**Need immediate help?** Check our [FAQ section](https://docs.superb-ai.com/faq) or contact support.
|
|
284
|
+
|
|
285
|
+
## 📄 License
|
|
286
|
+
|
|
287
|
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
|
288
|
+
|
|
289
|
+
---
|
|
290
|
+
|
|
291
|
+
**🚀 Ready to build something amazing?** Start with our [Quick Start Guide](#-quick-start) and explore the powerful features of Superb AI On-premise SDK!
|
|
292
|
+
|
|
293
|
+
<div align="center">
|
|
294
|
+
<sub>Built with ❤️ by the <a href="https://superb-ai.com">Superb AI</a> team</sub>
|
|
295
|
+
</div>
|
|
296
|
+
|