Media Server 24.1

# ListClassifiers

Lists the classifiers that you have created for use with image classification.

Type: synchronous

Parameter | Description | Required
--- | --- | ---
`trainingoptions` | A Boolean value (default false) that specifies whether to return the training options set for each classifier. | No

## Example

    /action=ListClassifiers&trainingoptions=TRUE

## Response

The response includes a list of classifiers, with the following information:

- `classifier` - the name of the classifier.

- `state` - describes the state of the classifier.

  - `TRAINED` - the classifier has been trained and is ready to use.
  - `TRAINING` - training is in progress.
  - `SNAPSHOTTED` - the classifier has been trained but a snapshot should be selected. You can use the classifier in this state (Media Server uses the model with the greatest number of iterations). You can evaluate a snapshot with the action TestClassifierSnapshot followed by GetClassifierSnapshotStatistics. You can then select the snapshot to use by running SelectClassifierSnapshot, which moves the classifier to the `TRAINED` state. For more information about snapshots, refer to the Media Server Administration Guide.
  - `STALE` - the classifier requires training. You can begin training with the action BuildClassifier.
  - `PAUSED` - training has been paused by the action PauseBuildClassifier. You cannot use the classifier in this state. Resume training by running the action BuildClassifier.
- `numclasses` - the number of classes that exist in the classifier.
- `remaining_iterations` - the number of training iterations that are remaining. This element is present only when training is paused.
- `snapshots` - lists the snapshots that were generated during training. A snapshot captures the state of a classifier after a certain number of iterations.
- `trainingoptions` - shows the training options that are associated with the classifier. This element is present only when you set the action parameter `trainingoptions=true`, and have set one or more training options with the action SetClassifierTrainingOption.

    <autnresponse>
        <action>LISTCLASSIFIERS</action>
        <response>SUCCESS</response>
        <responsedata>
            <classifier>
                <classifier>vehicles</classifier>
                <state>SNAPSHOTTED</state>
                <numclasses>3</numclasses>
                <snapshots>
                    <snapshot>
                        <index>0</index>
                        <iterations>2000</iterations>
                    </snapshot>
                    <snapshot>
                        <index>1</index>
                        <iterations>500</iterations>
                    </snapshot>
                    <snapshot>
                        <index>2</index>
                        <iterations>1000</iterations>
                    </snapshot>
                    <snapshot>
                        <index>3</index>
                        <iterations>1500/iterations>
                    </snapshot>
                </snapshots>
                <trainingoptions>
                    <trainingoption>
                        <key>iterations</key>
                        <value>2000</value>
                    </trainingoption>
                    <trainingoption>
                        <key>snapshot_frequency</key>
                        <value>500</value>
                    </trainingoption>
                </trainingoptions>
            </classifier>
        </responsedata>
    </autnresponse>

Copyright 2023 Open Text
Version 24.1 | Last updated December 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Media Server 24.1

Topic Title: ListClassifiers