Method encode

modelscope/preprocessors/templates/base.py:409–430

The entrance method of Template! Args: example: The input example streaming: If is streaming mode is_training: Use template in training **kwargs: model: The model instance, use only in `is_training=False` Returns:

(self, example: Dict[str, Any], streaming: bool = False, is_training: bool = False, **kwargs)

        return example

    def encode(self, example: Dict[str, Any], streaming: bool = False, is_training: bool = False, **kwargs) -> Tuple[Dict[str, Any], Dict[str, Any]]:
        """The entrance method of Template!

        Args:
            example: The input example
            streaming: If is streaming mode
            is_training: Use template in training
            **kwargs:
                model: The model instance, use only in `is_training=False`
        Returns:
            if not streaming mode, returns tuple of (example, tokenizer_kwargs), else return example only
        """
        example = self.preprocess(example)
        res = self._encode(example, **kwargs)
        inputs = res[0]
        if not is_training and '_data' in inputs:
            model = kwargs.get('model')
            assert model is not None
            data = inputs.pop('_data')
            data = to_device(data, model.device)
            inputs.update(self.post_encode(model, data))
        return res if not streaming else inputs

    def _encode(self, example: Dict[str, Any], **kwargs) -> Tuple[Dict[str, Any], Dict[str, Any]]:
        """return: inputs, tokenizer_kwargs"""