mindspore2022/docs/api/api_python/dataset_text/mindspore.dataset.text.SentencePieceVocab.rst

mindspore.dataset.text.SentencePieceVocab
==========================================

.. py:class:: mindspore.dataset.text.SentencePieceVocab

    用于执行分词的SentencePiece对象。

    .. py:method:: from_dataset(dataset, col_names, vocab_size, character_coverage, model_type, params)

        从数据集构建SentencePiece。

        **参数：**

        - **dataset** (Dataset) - 表示用于构建SentencePiece对象的数据集。
        - **col_names** (list) - 表示列名称的列表。
        - **vocab_size** (int) - 表示词汇大小。
        - **character_coverage** (float) - 表示模型涵盖的字符数。推荐的默认值为：0.9995，适用于具有丰富字符集的语言，如日文或中文，1.0适用于具有小字符集的其他语言。
        - **model_type** (SentencePieceModel) - 其值可以是SentencePieceModel.UNIGRAM、SentencePieceModel.BPE、SentencePieceModel.CHAR或SentencePieceModel.WORD，默认值：SentencePieceModel.UNIgram。使用SentencePieceModel.WORD类型时，必须预先标记输入句子。

          - SentencePieceModel.UNIGRAM：Unigram语言模型意味着句子中的下一个单词被假定为独立于模型生成的前一个单词。
          - SentencePieceModel.BPE：指字节对编码算法，它取代了最频繁的对句子中的字节数，其中包含一个未使用的字节。
          - SentencePieceModel.CHAR：引用基于字符的SentencePiece模型类型。
          - SentencePieceModel.WORD：引用基于单词的SentencePiece型类型。

        - **params** (dict)：表示没有传入参数的字典。

        **返回：**

        SentencePieceVocab，从数据集构建的vocab。

    .. py:method:: from_file(file_path, vocab_size, character_coverage, model_type, params)

        从文件中构建一个SentencePiece对象。

        **参数：**

        - **file_path** (list) - 表示包含SentencePiece列表的文件的路径。
        - **vocab_size** (int) - 表示词汇大小。
        - **character_coverage** (float) - 表示模型涵盖的字符数。推荐的默认值为：0.9995适用于具有丰富字符集的语言，如日文或中文，1.0适用于具有小字符集的其他语言。
        - **model_type** (SentencePieceModel) - 其值可以是SentencePieceModel.UNIGRAM、SentencePieceModel.BPE、SentencePieceModel.CHAR或SentencePieceModel.WORD，默认值为SentencePieceModel.UNIgram。使用SentencePieceModel.WORD类型时，必须预先标记输入句子。

          - SentencePieceModel.UNIGRAM：Unigram语言模型意味着句子中的下一个单词被假定为独立于模型生成的前一个单词。
          - SentencePieceModel.BPE：指字节对编码算法，它取代了最频繁的对句子中的字节数，其中包含一个未使用的字节。
          - SentencePieceModel.CHAR：引用基于字符的SentencePiece模型类型。
          - SentencePieceModel.WORD：引用基于单词的SentencePiece型类型。

        - **params** (dict)：表示没有传入参数的字典（参数派生自SentencePiece库）。

          .. code-block::

              input_sentence_size 0
              max_sentencepiece_length 16

        **返回：**

        SentencePieceVocab，表示从文件中构建的vocab。

    .. py:method:: save_model(vocab, path, filename)

        将模型保存到给定的文件路径。

        **参数：**

        - **vocab** (SentencePieceVocab) - 表示一个SentencePiece对象。
        - **path** (str) - 表示存储模型的路径。
        - **filename** (str) - 表示文件名称。