Package Api Documentation for mlconjug

Referência de API para as classes em mlconjug.mlconjug.py

Módulo principal do MLConjug.

Este módulo declara as principais classes com as quais o usuário interage.

O módulo define as classes necessárias para interagir com os modelos de Machine Learning.

mlconjug.mlconjug.extract_verb_features(verb, lang, ngram_range)

Custom Vectorizer otimizado para extrair recursos de verbos.

O vetorizador subclasse sklearn.feature_extraction.text.CountVectorizer.

As in Indo-European languages verbs are inflected by adding a morphological suffix, the vectorizer extracts verb endings and produces a vector representation of the verb with binary features.

Para aprimorar os resultados da extração de recursos, vários outros recursos foram incluídos:

As características são o final do verbo n-grams, iniciando n-grams, comprimento do verbo, número de vogais, número de consoantes e a razão entre vogais e consoantes.

Parâmetros:

• verb – string. Verb para vetorizar.
• lang – string. Language to analyze.
• ngram_range – tupla. O intervalo da janela deslizante do ngram.

Retorno:

Lista. Lista das características mais salientes do verbo para a tarefa de encontrar sua classe de conjugação.

class mlconjug.mlconjug.Conjugator(language='fr', model=None)

Esta é a principal classe do projeto.

The class manages the Verbiste data set and provides an interface with the scikit-learn pipeline.

If no parameters are provided, the default language is set to french and the pre-trained french conjugation pipeline is used.

A classe define o método conjugado (verbo, idioma) que é o método principal do módulo.

Parâmetros:

• language – string. Linguagem do conjugador. O idioma padrão é “fr” para francês.
• model – mlconjug.Model ou scikit-learn Pipeline ou Classifier que implementam os métodos fit () e predict (). Um usuário forneceu o pipeline se o usuário tiver treinado seu próprio pipeline.

conjugate(verb, subject='abbrev')

Este é o principal método desta classe.

Primeiro, verifica se o verbo está em Verbiste.

If it is not, and a pre-trained scikit-learn pipeline has been supplied, the method then calls the pipeline to predict the conjugation class of the provided verb.

Retorna um objeto Verbo ou Nenhum.

Parâmetros:

• verb – string. Verb para conjugar.
• subject – string. Alterna os pronomes abreviados ou completos. O valor padrão é “abrev”. Selecione “pronome” para os pronomes completos.

Retorno:

Objeto Verbo ou Nenhum.

set_model(model)

Assigns the provided pre-trained scikit-learn pipeline to be able to conjugate unknown verbs.

Parâmetros:model – Classificador ou Pipeline do scikit-learn.

class mlconjug.mlconjug.DataSet(verbs_dict)

Esta classe mantém e gerencia o conjunto de dados.

Defines helper methodss for managing Machine Learning tasks like constructing a training and testing set.

Parâmetros:verbs_dict – Um dicionário de verbos e sua classe de conjugação correspondente.

construct_dict_conjug()

Popula o dicionário que contém os modelos de conjugação.

Popula as listas contendo os verbos e seus modelos.

split_data(threshold=8, proportion=0.5)

Divide os dados em um treinamento e um conjunto de testes.

Parâmetros:

• threshold – int. Tamanho mínimo da classe de conjugação a ser dividida.
• proportion – float. Proporção de amostras no conjunto de treino. Deve estar entre 0 e 1.

class mlconjug.mlconjug.Model(vectorizer=None, feature_selector=None, classifier=None, language=None)

Bases:: class:` objeto`

This class manages the scikit-learn pipeline.

O Pipeline inclui um vetorizador de recursos, um seletor de recursos e um classificador.

If any of the vectorizer, feature selector or classifier is not supplied at instance declaration, the __init__ method will provide good default values that get more than 92% prediction accuracy.

Parâmetros:

• vectorizer – scikit-learn Vectorizer
• feature_selector – classificador scikit-learn com um método fit_transform ()
• classifier – classificador scikit-learn com um método predict ()
• language – linguagem do corpus de verbos a ser analisado.

train(samples, labels)

Trains the pipeline on the supplied samples and labels.

Parâmetros:

• samples – lista. Lista de verbos.
• labels – lista. Lista de modelos de verbos.

predict(verbs)

Prevê a classe de conjugação da lista de verbos fornecida.

Parâmetros:verbs – lista. Lista de verbos. Retorno:lista. Lista de grupos de conjugação previstos.

Referência de API para as classes em mlconjug.PyVerbiste.py

PyVerbiste.

Uma biblioteca Python para conjugar verbos em francês, inglês, espanhol, italiano, português e romeno (mais em breve).

Ele contém dados de conjugação gerados por modelos de aprendizado de máquina usando a biblioteca python mlconjug.

Mais informações sobre mlconjug em https://pypi.org/project/mlconjug/

Os dados de conjugação estão em conformidade com o esquema XML definido pela Verbiste.

Mais informações sobre a Verbiste em https://perso.b2b2c.ca/~sarrazip/dev/conjug_manager.html

class mlconjug.PyVerbiste.ConjugManager(language='default')

This is the class handling the mlconjug json files.

Parâmetros:language – string. | The language of the conjugator. The default value is fr for French. | The allowed values are: fr, en, es, it, pt, ro.

_load_verbs(verbs_file)

Load and parses the verbs from the json file.

Parâmetros:verbs_file – string or path object. Path to the verbs json file.

_load_conjugations(conjugations_file)

Load and parses the conjugations from the xml file.

Parâmetros:conjugations_file – string ou caminho do objeto. Caminho para o arquivo xml de conjugação.

_detect_allowed_endings()

Detecta os finais permitidos para verbos nos idiomas suportados.

Todos os idiomas suportados, exceto o inglês, restringem a forma que um verbo pode receber.

Como o inglês é muito mais produtivo e variado na morfologia de seus verbos, qualquer palavra é permitida como um verbo.

Retorno:set. Um conjunto contendo as terminações permitidas de verbos no idioma de destino.

is_valid_verb(verb)

Verifica se o verbo é um verbo válido na língua dada.

Palavras inglesas são sempre tratadas como verbos possíveis.

Verbos em outros idiomas são filtrados por seus finais.

Parâmetros:verb – string. O verbo para conjugar. Retorno:bool. Verdadeiro se o verbo é um verbo válido na língua. Falso caso contrário.

get_verb_info(verb)

Obtém informações verbais e retorna uma instância VerbInfo.

Parâmetros:verb – string. Verb para conjugar. Retorno:Objeto VerbInfo ou Nenhum.

get_conjug_info(template)

Obtém informações de conjugação correspondentes ao modelo fornecido.

Parâmetros:template – string. Nome do padrão final do verbo. Retorno:OrderedDict ou None. OrderedDict contendo os sufixos conjugados do template.

class mlconjug.PyVerbiste.Verbiste(language='default')

Bases: mlconjug.PyVerbiste.ConjugManager

Esta é a classe que manipula os arquivos xml da Verbiste.

Parâmetros:language – string. | The language of the conjugator. The default value is fr for French. | The allowed values are: fr, en, es, it, pt, ro.

_load_verbs(verbs_file)

Load and parses the verbs from the xml file.

Parâmetros:verbs_file – string ou caminho do objeto. Caminho para o arquivo xml verbos.

_parse_verbs(file)

Parses the XML file.

Parâmetros:file – FileObject. Arquivo XML contendo os verbos. Retorno:OrderedDict. Um OrderedDict contendo o verbo e seu modelo para todos os verbos no arquivo.

_load_conjugations(conjugations_file)

Load and parses the conjugations from the xml file.

Parâmetros:conjugations_file – string ou caminho do objeto. Caminho para o arquivo xml de conjugação.

_parse_conjugations(file)

Parses the XML file.

Parâmetros:file – FileObject. Arquivo XML contendo os modelos de conjugação. Retorno:OrderedDict. Um OrderedDict contendo todos os modelos de conjugação no arquivo.

_load_tense(tense)

Carregue e analise os formulários flexionados do tempo do arquivo xml.

Parâmetros:tense – lista de tags xml contendo formulários flexionados. A lista de formulários flexionados para o tempo atual sendo processado. Retorno:list. List of inflected forms.

_detect_allowed_endings()

Detecta os finais permitidos para verbos nos idiomas suportados.

Todos os idiomas suportados, exceto o inglês, restringem a forma que um verbo pode receber.

Como o inglês é muito mais produtivo e variado na morfologia de seus verbos, qualquer palavra é permitida como um verbo.

Retorno:set. Um conjunto contendo as terminações permitidas de verbos no idioma de destino.

get_conjug_info(template)

Obtém informações de conjugação correspondentes ao modelo fornecido.

Parâmetros:template – string. Nome do padrão final do verbo. Retorno:OrderedDict ou None. OrderedDict contendo os sufixos conjugados do template.

get_verb_info(verb)

Obtém informações verbais e retorna uma instância VerbInfo.

Parâmetros:verb – string. Verb para conjugar. Retorno:Objeto VerbInfo ou Nenhum.

is_valid_verb(verb)

Verifica se o verbo é um verbo válido na língua dada.

Palavras inglesas são sempre tratadas como verbos possíveis.

Verbos em outros idiomas são filtrados por seus finais.

Parâmetros:verb – string. O verbo para conjugar. Retorno:bool. Verdadeiro se o verbo é um verbo válido na língua. Falso caso contrário.

class mlconjug.PyVerbiste.VerbInfo(infinitive, root, template)

Esta classe define a estrutura da informação verbal Verbiste.

Parâmetros:

• infinitive – string. Forma infinitiva do verbo.
• root – string. Raiz lexical do verbo.
• template – string. Nome do padrão final do verbo.

class mlconjug.PyVerbiste.Verb(verb_info, conjug_info, subject='abbrev', predicted=False)

This class defines the Verb Object. TODO: Make the conjugated forms iterable by implementing the iterator protocol.

Parâmetros:

• verb_info – Objeto VerbInfo»
• conjug_info – OrderedDict.
• subject – string. Alterna os pronomes abreviados ou completos. O valor padrão é “abrev”. Selecione “pronome” para os pronomes completos.
• predicted – bool. Indica se as informações de conjugação foram previstas pelo modelo ou recuperadas do conjunto de dados.

iterate()

Iterates over all conjugated forms and returns a list of tuples of those conjugated forms. :return:

_load_conjug()

Popula as formas flexionadas do verbo.

Esta é a versão genérica deste método.

Não acrescenta pronomes pessoais às formas conjugadas.

Este método pode manipular qualquer novo idioma se a estrutura de conjugação estiver em conformidade com o Esquema XML da Verbiste.

class mlconjug.PyVerbiste.VerbFr(verb_info, conjug_info, subject='abbrev', predicted=False)

Bases:: class:` mlconjug.PyVerbiste.Verb`

Esta classe define o Objeto Verbo Francês.

_load_conjug()

Popula as formas flexionadas do verbo.

Adiciona pronomes pessoais aos verbos flexionados.

iterate()

Iterates over all conjugated forms and returns a list of tuples of those conjugated forms. :return:

class mlconjug.PyVerbiste.VerbEn(verb_info, conjug_info, subject='abbrev', predicted=False)

Bases:: class:` mlconjug.PyVerbiste.Verb`

Esta classe define o Inglês Objeto Verbo.

_load_conjug()

Popula as formas flexionadas do verbo.

Adiciona pronomes pessoais aos verbos flexionados.

iterate()

Iterates over all conjugated forms and returns a list of tuples of those conjugated forms. :return:

class mlconjug.PyVerbiste.VerbEs(verb_info, conjug_info, subject='abbrev', predicted=False)

Bases:: class:` mlconjug.PyVerbiste.Verb`

Esta classe define o Objeto Verbo Espanhol.

_load_conjug()

Popula as formas flexionadas do verbo.

Adiciona pronomes pessoais aos verbos flexionados.

iterate()

Iterates over all conjugated forms and returns a list of tuples of those conjugated forms. :return:

class mlconjug.PyVerbiste.VerbIt(verb_info, conjug_info, subject='abbrev', predicted=False)

Bases:: class:` mlconjug.PyVerbiste.Verb`

Esta classe define o Objeto Verbo Italiano.

_load_conjug()

Popula as formas flexionadas do verbo.

Adiciona pronomes pessoais aos verbos flexionados.

iterate()

Iterates over all conjugated forms and returns a list of tuples of those conjugated forms. :return:

class mlconjug.PyVerbiste.VerbPt(verb_info, conjug_info, subject='abbrev', predicted=False)

Bases:: class:` mlconjug.PyVerbiste.Verb`

Esta classe define o Objeto Verbo Português.

_load_conjug()

Popula as formas flexionadas do verbo.

Adiciona pronomes pessoais aos verbos flexionados.

iterate()

Iterates over all conjugated forms and returns a list of tuples of those conjugated forms. :return:

class mlconjug.PyVerbiste.VerbRo(verb_info, conjug_info, subject='abbrev', predicted=False)

Bases:: class:` mlconjug.PyVerbiste.Verb`

Esta classe define o Objeto Verbo Romeno.

iterate()

Iterates over all conjugated forms and returns a list of tuples of those conjugated forms. :return:

_load_conjug()

Popula as formas flexionadas do verbo.

Adiciona pronomes pessoais aos verbos flexionados.