<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/components/containers/category.py#L23-L87) |

A classification category.

    mp.tasks.components.containers.Category(
        index: Optional[int] = None,
        score: Optional[float] = None,
        display_name: Optional[str] = None,
        category_name: Optional[str] = None
    )

Category is a util class, contains a label, its display name, a float
value as score, and the index of the label in the corresponding label file.
Typically it's used as the result of classification tasks.

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `index` | The index of the label in the corresponding label file. |
| `score` | The probability score of this label category. |
| `display_name` | The display name of the label, which may be translated for different locales. For example, a label, "apple", may be translated into Spanish for display purpose, so that the `display_name` is "manzana". |
| `category_name` | The label of this category object. |

<br />

## Methods

### `from_ctypes`

[View source](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/components/containers/category.py#L45-L69)

    @classmethod
    from_ctypes(
        c_obj: category_c_module.MpCategoryC
    ) -> 'Category'

Creates a `Category` object from the given `MpCategoryC` object.

This function converts the `MpCategoryC` index of -1 to a Python value of
None
to retain the same semantic meaning. All other values are converted as-is.

<br />

<br />

<br />

| Args ||
|---|---|
| `c_obj` | The `MpCategoryC` object to be converted. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| A `Category` object. ||

<br />

### `__eq__`

[View source](https://github.com/google-ai-edge/mediapipe/blob/master/mediapipe/tasks/python/components/containers/category.py#L71-L87)

    __eq__(
        other: Any
    ) -> bool

Checks if this object is equal to the given object.

<br />

<br />

<br />

| Args ||
|---|---|
| `other` | The object to be compared with. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| True if the objects are equal. ||

<br />

<br />

<br />

<br />

| ## Class Variables ||
|---|---|
| category_name | `None` |
| display_name | `None` |
| index | `None` |
| score | `None` |

<br />