<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/models/blob/v2.20.0/official/nlp/tasks/tagging.py#L81-L205) |

Task object for tagging (e.g., NER or POS).

Inherits From: [`Task`](https://www.tensorflow.org/api_docs/python/tfm/core/base_task/Task)

    tfm.nlp.tasks.TaggingTask(
        params, logging_dir: Optional[str] = None, name: Optional[str] = None
    )

<br />

<br />

<br />

| ## Args ||
|---|---|
| `params` | the task configuration instance, which can be any of dataclass, ConfigDict, namedtuple, etc. |
| `logging_dir` | a string pointing to where the model, summaries etc. will be saved. You can also write additional stuff in this directory. |
| `name` | the task name. |

<br />

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `logging_dir` | <br /> <br /> |
| `task_config` | <br /> <br /> |

<br />

## Methods

### `aggregate_logs`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/nlp/tasks/tagging.py#L172-L190)

    aggregate_logs(
        state=None, step_outputs=None
    )

Aggregates over logs returned from a validation step.

### `build_inputs`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/nlp/tasks/tagging.py#L114-L139)

    build_inputs(
        params: https://www.tensorflow.org/api_docs/python/tfm/core/config_definitions/DataConfig,
        input_context=None
    )

Returns tf.data.Dataset for sentence_prediction task.

### `build_losses`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/nlp/tasks/tagging.py#L104-L112)

    build_losses(
        labels, model_outputs, aux_losses=None
    ) -> tf.Tensor

Standard interface to compute losses.

<br />

<br />

<br />

| Args ||
|---|---|
| `labels` | optional label tensors. |
| `model_outputs` | a nested structure of output tensors. |
| `aux_losses` | auxiliary loss tensors, i.e. `losses` in keras.Model. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| The total loss tensor. ||

<br />

### `build_metrics`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/core/base_task.py#L189-L192)

    build_metrics(
        training: bool = True
    )

Gets streaming metrics for training/validation.

### `build_model`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/nlp/tasks/tagging.py#L85-L102)

    build_model()

\[Optional\] Creates model architecture.

<br />

<br />

<br />

| Returns ||
|---|---|
| A model instance. ||

<br />

### `create_optimizer`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/core/base_task.py#L72-L111)

    @classmethod
    create_optimizer(
        optimizer_config: https://www.tensorflow.org/api_docs/python/tfm/optimization/OptimizationConfig,
        runtime_config: Optional[https://www.tensorflow.org/api_docs/python/tfm/core/base_task/RuntimeConfig] = None,
        dp_config: Optional[https://www.tensorflow.org/api_docs/python/tfm/core/base_task/DifferentialPrivacyConfig] = None
    )

Creates an TF optimizer from configurations.

<br />

<br />

<br />

| Args ||
|---|---|
| `optimizer_config` | the parameters of the Optimization settings. |
| `runtime_config` | the parameters of the runtime. |
| `dp_config` | the parameter of differential privacy. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| A tf.optimizers.Optimizer object. ||

<br />

### `inference_step`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/nlp/tasks/tagging.py#L141-L145)

    inference_step(
        inputs, model: tf_keras.Model
    )

Performs the forward step.

### `initialize`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/core/base_task.py#L113-L142)

    initialize(
        model: tf_keras.Model
    )

\[Optional\] A callback function used as CheckpointManager's init_fn.

This function will be called when no checkpoint is found for the model.
If there is a checkpoint, the checkpoint will be loaded and this function
will not be called. You can use this callback function to load a pretrained
checkpoint, saved under a directory other than the model_dir.

<br />

<br />

<br />

| Args ||
|---|---|
| `model` | The keras.Model built or used by this task. |

<br />

### `process_compiled_metrics`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/core/base_task.py#L210-L221)

    process_compiled_metrics(
        compiled_metrics, labels, model_outputs
    )

Process and update compiled_metrics.

call when using compile/fit API.

<br />

<br />

<br />

| Args ||
|---|---|
| `compiled_metrics` | the compiled metrics (model.compiled_metrics). |
| `labels` | a tensor or a nested structure of tensors. |
| `model_outputs` | a tensor or a nested structure of tensors. For example, output of the keras model built by self.build_model. |

<br />

### `process_metrics`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/core/base_task.py#L194-L208)

    process_metrics(
        metrics, labels, model_outputs, **kwargs
    )

Process and update metrics.

Called when using custom training loop API.

<br />

<br />

<br />

| Args ||
|---|---|
| `metrics` | a nested structure of metrics objects. The return of function self.build_metrics. |
| `labels` | a tensor or a nested structure of tensors. |
| `model_outputs` | a tensor or a nested structure of tensors. For example, output of the keras model built by self.build_model. |
| `**kwargs` | other args. |

<br />

### `reduce_aggregated_logs`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/nlp/tasks/tagging.py#L192-L205)

    reduce_aggregated_logs(
        aggregated_logs, global_step=None
    )

Reduces aggregated logs over validation steps.

### `train_step`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/core/base_task.py#L223-L280)

    train_step(
        inputs,
        model: tf_keras.Model,
        optimizer: tf_keras.optimizers.Optimizer,
        metrics=None
    )

Does forward and backward.

With distribution strategies, this method runs on devices.

<br />

<br />

<br />

| Args ||
|---|---|
| `inputs` | a dictionary of input tensors. |
| `model` | the model, forward pass definition. |
| `optimizer` | the optimizer for this training step. |
| `metrics` | a nested structure of metrics objects. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| A dictionary of logs. ||

<br />

### `validation_step`

[View source](https://github.com/tensorflow/models/blob/v2.20.0/official/nlp/tasks/tagging.py#L147-L170)

    validation_step(
        inputs, model: tf_keras.Model, metrics=None
    )

Validatation step.

<br />

<br />

<br />

| Args ||
|---|---|
| `inputs` | a dictionary of input tensors. |
| `model` | the keras.Model. |
| `metrics` | a nested structure of metrics objects. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| A dictionary of logs. ||

<br />

<br />

<br />

<br />

| ## Class Variables ||
|---|---|
| loss | `'loss'` |

<br />