aibox.nlp.factory.class_registry

Implementação de um Class Registry, permitindo que classes sejam representadas como uma string.

Module Attributes

registry

Singleton do registro de entidades.

Functions

available_datasets()	Retorna uma lista dos datasets disponíveis.
available_estimators()	Retorna uma lista dos estimadores disponíveis.
available_extractors()	Retorna uma lista dos extratores de características disponíveis.
available_metrics()	Retorna uma lista das métricas disponíveis.
available_vectorizers()	Retorna uma lista dos vetorizadores disponíveis.
get_class(key)	Retorna a classe do identificador recebido como argumento.

Classes

Registry()

Registro de identificadores de entidades.

class aibox.nlp.factory.class_registry.Registry

Base: object

Registro de identificadores de entidades.

Essa é uma classe utilitária utilizada para os métodos factory. Esse registro contém uma lista de todos as entidades da biblioteca.

Registro de entidades da biblioteca.

{
    "features_br": {
        "agreementBR": "agreement.AgreementExtractor",
        "bertSimilarityBR": "bert_similarity.BERTSimilarityExtractor",
        "cohmetrixBR": "cohmetrix.CohMetrixExtractor",
        "conjugationBR": "conjugation.ConjugationExtractor",
        "connectivesV1BR": "connectives_v1.ConnectivesExtractorV1",
        "connectivesV2BR": "connectives_v2.ConnectivesExtractorV2",
        "descriptiveBR": "descriptive.DescriptiveExtractor",
        "fuzzySimilarity": "fuzzy_search_similarity.FuzzySearchSimilarityExtractor",
        "lexicalDiversityBR": "lexical_diversity.LexicalDiversityExtractor",
        "liwcBR": "liwc.LiwcExtractor",
        "nilcSimilarityBR": "nilc_similarity.NILCSimilarityExtractor",
        "orthographyBR": "orthography.OrthographyExtractor",
        "overlapBR": "overlap.OverlapExtractor",
        "readabilityBR": "readability.ReadabilityExtractor",
        "referentialCohesionBR": "referential_cohesion.ReferentialCohesionExtractor",
        "regencyBR": "regency.RegencyExtractor",
        "semanticCohesionTransformersBR": "semantic_cohesion_transformers.SemanticExtractorTransformers",
        "semanticCohesionBR": "semantic_cohesion.SemanticExtractor",
        "sequentialCohesionBR": "sequential_cohesion.SequentialCohesionExtractor",
        "syntacticComplexityBR": "syntactic_complexity.SyntacticComplexityExtractor",
        "textualSimplicityBR": "textual_simplicity.TextualSimplicityExtractor",
        "tfidfSimilarity": "tfidf_similarity.TFIDFSimilarityExtractor",
        "wordMorphosyntacticInformationBR": "word_morphosyntactic_information.WordMorphosyntacticInformationExtractor",
        "wordSegmentationBR": "word_segmentation.WordSegmentationExtractor"
    },
    "features_en": {},
    "vectorizers": {
        "tfidfVectorizer": "tfidf_vectorizer.TFIDFVectorizer",
        "bertVectorizer": "bert_vectorizer.BertVectorizer",
        "fasttextWordVectorizer": "fasttext_word_vectorizer.FasttextWordVectorizer",
        "__identity": "identity.IdentityVectorizer"
    },
    "metrics": {
        "R2": "errors.R2",
        "MAE": "errors.MAE",
        "MSE": "errors.MSE",
        "RMSE": "errors.RMSE",
        "kappa": "kappa.CohensKappaScore",
        "neighborKappa": "kappa.NeighborCohensKappaScore",
        "accuracy": "accuracy.Accuracy",
        "precision": "precision.Precision",
        "recall": "recall.Recall",
        "f1": "f1_score.F1Score"
    },
    "estimators": {
        "svm": "classification.svm.SVM",
        "svr": "regression.svr.SVR",
        "nbClf": "classification.gaussian_nb.GaussianNBClassifier",
        "knClf": "classification.kn_classifier.KNeighborsClassifier",
        "knReg": "regression.kn_regressor.KNeighborsRegressor",
        "catboostClf": "classification.catboost_classifier.CatBoostClassifier",
        "catboosetReg": "regression.catboost_regressor.CatBoostRegressor",
        "etreesClf": "classification.extra_trees_classifier.ExtraTreesClassifier",
        "etreesReg": "regression.extra_trees_regressor.ExtraTreesRegressor",
        "lgbmClf": "classification.lgbm_classifier.LGBMClassifier",
        "lgbmReg": "regression.lgbm_regressor.LGBMRegressor",
        "mlpClf": "classification.mlp_classifier.MLPClassifier",
        "mlpReg": "regression.mlp_regressor.MLPRegressor",
        "lstmClf": "classification.lstm_classifier.LSTMClassifier",
        "lstmReg": "regression.lstm_regressor.LSTMRegressor",
        "rfClf": "classification.random_forest_classifier.RandomForestClassifier",
        "adaBoostClf": "classification.adaboost_classifier.AdaBoostClassifier",
        "adaBoostReg": "regression.adaboost_regressor.AdaBoostRegressor",
        "rfReg": "regression.random_forest_regressor.RandomForestRegressor",
        "xgbClf": "classification.xgboost_classifier.XGBoostClassifier",
        "xgbReg": "regression.xgboost_regressor.XGBoostRegressor",
        "transformerClf": "classification.transformer_classifier.TransformerClassifier",
        "transformerReg": "regression.transformer_regressor.TransformerRegressor"
    },
    "datasets": {
        "essayBR": "essay_br.DatasetEssayBR",
        "narrativeEssaysBR": "portuguese_narrative_essays.DatasetPortugueseNarrativeEssays"
    }
}

property estimators: dict[str, str]

Mapeamento de identificador de estimadores para suas respectivas classes.

property datasets: dict[str, str]

Mapeamento de identificador de datasets para suas respectivas classes.

property features_br: dict[str, str]

Mapeamento de identificador de extratores de características para o português brasileiro para suas respectivas classes.

property metrics: dict[str, str]

Mapeamento de identificador de métricas para suas respectivas classes.

property vectorizers: dict[str, str]

Mapeamento de identificador de vetorizadores para suas respectivas classes.

get_registry_for(kind: str) → dict[str, str]

Retorna as entradas do registro para um dado tipo.

Parâmetros:

kind (str) – tipo das entradas.

Retorna:

registro para esse tipo.

Tipo de retorno:

dict[str, str]

get_path(identifier: str) → str

Dado um identificador para uma classe, retorna o caminho até essa classe seguindo o padrão de import de Python (e.g., package_a.package_b.module_c.ClassD)

Parâmetros:

identifier (str) – identificador.

Retorna:

caminho até a classe.

Tipo de retorno:

str

aibox.nlp.factory.class_registry.registry = <aibox.nlp.factory.class_registry.Registry object>

Singleton do registro de entidades.

aibox.nlp.factory.class_registry.get_class(key: str) → type

Retorna a classe do identificador recebido como argumento.

Parâmetros:

key (str) – identificador.

Retorna:

classe associada ao identificador.

Tipo de retorno:

type

aibox.nlp.factory.class_registry.available_datasets() → list[str]

Retorna uma lista dos datasets disponíveis.

Retorna:

datasets disponíveis.

Tipo de retorno:

list[str]

aibox.nlp.factory.class_registry.available_extractors() → list[str]

Retorna uma lista dos extratores de características disponíveis.

Retorna:

extratores disponíveis.

Tipo de retorno:

list[str]

aibox.nlp.factory.class_registry.available_metrics() → list[str]

Retorna uma lista das métricas disponíveis.

Retorna:

métricas disponíveis.

Tipo de retorno:

list[str]

aibox.nlp.factory.class_registry.available_vectorizers() → list[str]

Retorna uma lista dos vetorizadores disponíveis.

Retorna:

vetorizadores disponíveis.

Tipo de retorno:

list[str]

aibox.nlp.factory.class_registry.available_estimators() → list[str]

Retorna uma lista dos estimadores disponíveis.

Retorna:

estimadores disponíveis.

Tipo de retorno:

list[str]