API Reference

Welcome to the API Reference

• ParamsReader
  • ParamsInput
  • ParamsReader
    • ParamsReader.read()
• Datasets
  • Classes
    • mlcompare.data.BaseDataset
      • BaseDataset
    • mlcompare.data.LocalDataset
      • LocalDataset
    • mlcompare.data.HuggingFaceDataset
      • HuggingFaceDataset
    • mlcompare.data.KaggleDataset
      • KaggleDataset
    • mlcompare.data.OpenMLDataset
      • OpenMLDataset
    • mlcompare.data.DatasetFactory
      • DatasetFactory
• BaseDataset
  • BaseDataset
    • BaseDataset.create_save_name()
    • BaseDataset.drop
    • BaseDataset.get_data()
    • BaseDataset.label_encode
    • BaseDataset.max_abs_scale
    • BaseDataset.min_max_scale
    • BaseDataset.model_computed_fields
    • BaseDataset.model_config
    • BaseDataset.model_fields
    • BaseDataset.model_post_init()
    • BaseDataset.nan
    • BaseDataset.normalize
    • BaseDataset.one_hot_encode
    • BaseDataset.ordinal_encode
    • BaseDataset.power_transform
    • BaseDataset.quantile_transform
    • BaseDataset.quantile_transform_normal
    • BaseDataset.robust_scale
    • BaseDataset.save_name
    • BaseDataset.standard_scale
    • BaseDataset.target
    • BaseDataset.target_encode
• LocalDataset
  • LocalDataset
    • LocalDataset.create_save_name()
    • LocalDataset.file_path
    • LocalDataset.get_data()
    • LocalDataset.model_computed_fields
    • LocalDataset.model_config
    • LocalDataset.model_fields
    • LocalDataset.model_post_init()
    • LocalDataset.validate_data()
• KaggleDataset
  • KaggleDataset
    • KaggleDataset.create_save_name()
    • KaggleDataset.dataset
    • KaggleDataset.file
    • KaggleDataset.get_data()
    • KaggleDataset.model_computed_fields
    • KaggleDataset.model_config
    • KaggleDataset.model_fields
    • KaggleDataset.model_post_init()
    • KaggleDataset.user
    • KaggleDataset.validate_data()
• HuggingFaceDataset
  • HuggingFaceDataset
    • HuggingFaceDataset.create_save_name()
    • HuggingFaceDataset.file
    • HuggingFaceDataset.get_data()
    • HuggingFaceDataset.model_computed_fields
    • HuggingFaceDataset.model_config
    • HuggingFaceDataset.model_fields
    • HuggingFaceDataset.model_post_init()
    • HuggingFaceDataset.repo
• OpenMLDataset
  • OpenMLDataset
    • OpenMLDataset.create_save_name()
    • OpenMLDataset.get_data()
    • OpenMLDataset.id
    • OpenMLDataset.model_computed_fields
    • OpenMLDataset.model_config
    • OpenMLDataset.model_fields
    • OpenMLDataset.model_post_init()
• DatasetFactory
  • DatasetFactory
    • DatasetFactory.create()
• Data Processing
  • Classes
    • mlcompare.data.dataset_processor.DatasetProcessor
      • DatasetProcessor
    • mlcompare.data.split_data.SplitData
      • SplitData
• DatasetProcessor
  • DatasetProcessor
    • DatasetProcessor.drop_columns()
    • DatasetProcessor.handle_nan()
    • DatasetProcessor.label_encode_column()
    • DatasetProcessor.max_abs_scale_columns()
    • DatasetProcessor.min_max_scale_columns()
    • DatasetProcessor.normalize_columns()
    • DatasetProcessor.one_hot_encode_columns()
    • DatasetProcessor.ordinal_encode_columns()
    • DatasetProcessor.power_transform_columns()
    • DatasetProcessor.process_dataset()
    • DatasetProcessor.quantile_transform_columns()
    • DatasetProcessor.quantile_transform_normal_columns()
    • DatasetProcessor.robust_scale_columns()
    • DatasetProcessor.save_data()
    • DatasetProcessor.split_and_save_data()
    • DatasetProcessor.split_target()
    • DatasetProcessor.standard_scale_columns()
    • DatasetProcessor.target_encode_columns()
• SplitData
  • SplitData
    • SplitData.X_test
    • SplitData.X_train
    • SplitData.model_computed_fields
    • SplitData.model_config
    • SplitData.model_fields
    • SplitData.y_test
    • SplitData.y_train
• Models
  • Classes
    • mlcompare.models.models.LibraryModel
      • LibraryModel
    • mlcompare.models.models.SklearnModel
      • SklearnModel
    • mlcompare.models.models.XGBoostModel
      • XGBoostModel
    • mlcompare.models.models.ModelFactory
      • ModelFactory
• LibraryModel
  • LibraryModel
    • LibraryModel.instantiate_model()
    • LibraryModel.model_computed_fields
    • LibraryModel.model_config
    • LibraryModel.model_fields
    • LibraryModel.model_post_init()
    • LibraryModel.module
    • LibraryModel.name
    • LibraryModel.params
    • LibraryModel.predict()
    • LibraryModel.resolve_model_submodule()
    • LibraryModel.save()
    • LibraryModel.train()
• SklearnModel
  • SklearnModel
    • SklearnModel.model_computed_fields
    • SklearnModel.model_config
    • SklearnModel.model_fields
    • SklearnModel.model_post_init()
    • SklearnModel.predict()
    • SklearnModel.train()
• XGBoostModel
  • XGBoostModel
    • XGBoostModel.model_computed_fields
    • XGBoostModel.model_config
    • XGBoostModel.model_fields
    • XGBoostModel.model_post_init()
    • XGBoostModel.predict()
    • XGBoostModel.train()
• ModelFactory
  • ModelFactory
    • ModelFactory.create()
• Pipelines
  • Functions
    • mlcompare.full_pipeline
      • full_pipeline()
    • mlcompare.data_exploration_pipeline
      • data_exploration_pipeline()
• Full Pipeline
  • full_pipeline
• Data Pipeline
  • data_pipeline