Registry / ai-ml / azure-cognitiveservices-vision-customvision

azure-cognitiveservices-vision-customvision

library3.1.1pypypi✓ verified 88d ago

Microsoft Azure Custom Vision Client Library for Python (version 3.1.1). Allows building, training, and deploying custom image classifiers and object detection models. Low-level functionality; newer azure-ai-vision SDK is recommended. This package is in maintenance mode: no new features, only critical bug fixes. Release cadence is irregular.

ai-ml

pip install azure-cognitiveservices-vision-customvision

github ↗homepage ↗

INSTALL

IMPORT

SIG · AZURE-COGNITIVESER

azure-cognitiveservices-vision-customvision

ai-mlpythonv3.1.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

CustomVisionTrainingClient

✓ from azure.cognitiveservices.vision.customvision.training import CustomVisionTrainingClient

✗ from azure.cognitiveservices.vision.customvision.training.training import CustomVisionTrainingClient

Extra training.training nesting is incorrect.

CustomVisionPredictionClient

✓ from azure.cognitiveservices.vision.customvision.prediction import CustomVisionPredictionClient

✗ from azure.cognitiveservices.vision.customvision.prediction.prediction import CustomVisionPredictionClient

Extra prediction.prediction nesting is incorrect.

Initialize training client and create a project. Set TRAINING_ENDPOINT and TRAINING_KEY env vars.

from azure.cognitiveservices.vision.customvision.training import CustomVisionTrainingClient from msrest.authentication import ApiKeyCredentials ENDPOINT = os.environ.get('TRAINING_ENDPOINT', '') KEY = os.environ.get('TRAINING_KEY', '') credentials = ApiKeyCredentials(in_headers={"Training-key": KEY}) trainer = CustomVisionTrainingClient(ENDPOINT, credentials) # Create a project project = trainer.create_project("My Project") print("Project created:", project.id)

Debug

Known issues

deprecatedThis SDK is in maintenance mode and will no longer receive new features. Microsoft recommends migrating to azure-ai-vision (Image Analysis SDK) or other modern solutions.

fix

Use azure-ai-vision for new projects; see https://aka.ms/azsdk/azure-ai-vision

affects: all

gotchaTraining client uses 'Training-key' header for authentication, not 'Ocp-Apim-Subscription-Key' like many other Azure services.

fix

Always use ApiKeyCredentials(in_headers={'Training-key': key}) for training API.

affects: all

gotchaPrediction endpoint is different from training endpoint and often includes the project ID. Using the wrong endpoint leads to authorization errors.

fix

Obtain the prediction endpoint from the Custom Vision portal (e.g., https://<region>.api.cognitive.microsoft.com). For prediction, use PredictionEndpoint from the portal settings.

affects: all

Errors

Common errors & fixes

AttributeError: module 'azure.cognitiveservices.vision.customvision' has no attribute 'training'

Incorrect import path: missing 'training' or 'prediction' subpackage.

fix

Use correct import: from azure.cognitiveservices.vision.customvision.training import CustomVisionTrainingClient

requests.exceptions.HTTPError: 401 Client Error: Unauthorized

Using wrong authentication header (e.g., Ocp-Apim-Subscription-Key instead of Training-key).

fix

Use ApiKeyCredentials(in_headers={'Training-key': key}) for training. For prediction, use ApiKeyCredentials(in_headers={'Prediction-key': key}).

msrest.exceptions.ClientRequestError: The request is missing a required header.

Not providing the correct authentication header at all.

fix

Ensure you pass ApiKeyCredentials with either 'Training-key' or 'Prediction-key' header.

Upgrade

Version history

3.1.1latest on PyPI · released Nov 1, 2024

Audit

Dependencies

msrestrequiredRequired for HTTP client

azure-commonrequiredBase exception types

Agent activity

25 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/Azure/azure-sdk-for-python ↗

homepagehttps://github.com/Azure/azure-sdk-for-python ↗