aibox.nlp.core.experiment

Interface para um experimento.

Classes

Experiment()

Experimento de classificação/regressão com uma ou mais pipelines.

ExperimentConfiguration(dataset, metrics, ...)

Dataclass com a configuração de um experimento.

ExperimentResult(best_pipeline, ...[, extras])

Dataclass para resultados da execução de um experimento.

class aibox.nlp.core.experiment.ExperimentResult(best_pipeline: Pipeline, best_metrics: dict[str, ndarray], best_pipeline_test_predictions: ndarray, train_df: DataFrame, test_df: DataFrame, metrics_history: dict[str, dict[str, ndarray]], pipeline_history: dict[str, Pipeline], extras: object | None = None)[código-fonte]

Base: object

Dataclass para resultados da execução de um experimento.

Parâmetros:
  • best_pipeline (Pipeline) – melhor pipeline de acordo com o critério.

  • best_metrics (dict[str, ndarray]) – métricas para a melhor pipeline. Chaves representam o nome da métrica.

  • best_pipeline_test_predictions (ndarray) – predições no conjunto de testes para a melhor pipeline.

  • train_df (DataFrame) – conjunto de treinamento utilizado.

  • test_df (DataFrame) – conjunto de testes utilizado.

  • metrics_history (dict[str, dict[str, ndarray]]) – métricas de cada uma das pipelines treinadas. Chaves são o nome da pipeline.

  • pipeline_history (dict[str, Pipeline]) – histórico de pipelines treinadas.

  • extras (object | None) – informações extras que podem ser retornadas por experimentos específicos.

class aibox.nlp.core.experiment.ExperimentConfiguration(dataset: Dataset, metrics: list[str], best_criteria: str, extras: object | None = None)[código-fonte]

Base: object

Dataclass com a configuração de um experimento.

Parâmetros:
  • dataset (Dataset) – dataset a ser utilizado.

  • metrics (list[str]) – métricas a serem calculadas

  • best_criteria (str) – métrica a ser utilizada como melhor critério.

  • extras (object | None) – configurações extras que podem ser utilizadas por experimentos específicos.

class aibox.nlp.core.experiment.Experiment[código-fonte]

Base: ABC

Experimento de classificação/regressão com uma ou mais pipelines.

abstract run() ExperimentResult[código-fonte]

Executa o experimento e retorna os resultados.

Retorna:

resultados do experimento.

Tipo de retorno:

ExperimentResult

abstract config() ExperimentConfiguration[código-fonte]

Retorna as configurações desse experimento.

Retorna:

configuração do experimento.

Tipo de retorno:

ExperimentConfiguration