ads package
Subpackages
- ads.bds package
- ads.catalog package
- Submodules
- ads.catalog.model module
ModelModelArtifactSizeErrorModelCatalogModelCatalog.get_model()ModelCatalog.list_models()ModelCatalog.list_model_deployment()ModelCatalog.update_model()ModelCatalog.delete_model()ModelCatalog.download_model()ModelCatalog.upload_model()ModelCatalog.delete_model()ModelCatalog.download_model()ModelCatalog.get_model()ModelCatalog.list_model_deployment()ModelCatalog.list_models()ModelCatalog.update_model()ModelCatalog.upload_model()
ModelSummaryListModelWithActiveDeploymentError
- ads.catalog.notebook module
- ads.catalog.project module
- ads.catalog.summary module
- Module contents
- ads.common package
- Subpackages
- Submodules
- ads.common.analyzer module
- ads.common.auth module
- ads.common.base_properties module
BasePropertiesBaseProperties.with_prop()BaseProperties.with_dict()BaseProperties.with_env()BaseProperties.to_dict()BaseProperties.with_config()BaseProperties.from_dict()BaseProperties.from_config()BaseProperties.to_config()BaseProperties.from_config()BaseProperties.from_dict()BaseProperties.to_config()BaseProperties.to_dict()BaseProperties.with_config()BaseProperties.with_dict()BaseProperties.with_env()BaseProperties.with_prop()
- ads.common.card_identifier module
- ads.common.config module
- ads.common.data module
- ads.common.data_serializer module
- ads.common.error module
- ads.common.extended_enum module
- ads.common.ipython module
- ads.common.model module
ADSModelADSModel.convert_dataframe_schema()ADSModel.feature_names()ADSModel.from_estimator()ADSModel.get_init_types()ADSModel.is_classifier()ADSModel.predict()ADSModel.predict_proba()ADSModel.prepare()ADSModel.rename()ADSModel.score()ADSModel.show_in_notebook()ADSModel.summary()ADSModel.transform()ADSModel.visualize_transforms()
- ads.common.model_artifact module
ConflictStrategyInvalidDataTypeModelArtifactModelArtifact.artifact_dirModelArtifact.conflict_strategyModelArtifact.install_libsModelArtifact.reloadModelArtifact.createModelArtifact.progressModelArtifact.model_file_nameModelArtifact.inference_conda_envModelArtifact.data_science_envModelArtifact.ignore_deployment_errorModelArtifact.inference_python_versionModelArtifact.reload()ModelArtifact.verify()ModelArtifact.install_requirements()ModelArtifact.populate_metadata()ModelArtifact.introspect()ModelArtifact.from_model_catalog()ModelArtifact.install_requirements()ModelArtifact.introspect()ModelArtifact.populate_metadata()ModelArtifact.populate_schema()ModelArtifact.reload()ModelArtifact.save()ModelArtifact.verify()
PACK_TYPEVersionConflictWarningexecute()pip_install()
- ads.common.model_export_util module
- ads.common.model_introspect module
- ads.common.model_metadata module
- ads.common.model_metadata_mixin module
- ads.common.object_storage_details module
InvalidObjectStoragePathObjectStorageDetailsObjectStorageDetails.bucketObjectStorageDetails.namespaceObjectStorageDetails.filepathObjectStorageDetails.authObjectStorageDetails.authObjectStorageDetails.bucketObjectStorageDetails.fetch_metadata_of_object()ObjectStorageDetails.filepathObjectStorageDetails.from_path()ObjectStorageDetails.is_valid_uri()ObjectStorageDetails.namespaceObjectStorageDetails.pathObjectStorageDetails.to_tuple()
- ads.common.oci_client module
- ads.common.oci_datascience module
- ads.common.oci_logging module
- ads.common.oci_mixin module
MergeStrategyOCIClientMixinOCIModelMixinOCIModelMixin.CONS_COMPARTMENT_IDOCIModelMixin.OCI_MODEL_PATTERNOCIModelMixin.check_compartment_id()OCIModelMixin.delete()OCIModelMixin.deserialize()OCIModelMixin.flatten()OCIModelMixin.from_dict()OCIModelMixin.from_oci_model()OCIModelMixin.from_ocid()OCIModelMixin.list_resource()OCIModelMixin.load_properties_from_env()OCIModelMixin.nameOCIModelMixin.statusOCIModelMixin.sync()OCIModelMixin.to_dict()OCIModelMixin.to_oci_model()OCIModelMixin.to_yaml()OCIModelMixin.update_from_oci_model()
OCIModelNotExistsOCIModelWithNameMixinOCISerializableMixinOCIWorkRequestMixin
- ads.common.oci_resource module
- ads.common.serializer module
DataClassSerializableSerializableSerializable.to_dict()Serializable.from_dict()Serializable._write_to_file()Serializable._read_from_file()Serializable.to_json()Serializable.from_json()Serializable.to_yaml()Serializable.from_yaml()Serializable.from_string()Serializable.from_dict()Serializable.from_json()Serializable.from_string()Serializable.from_yaml()Serializable.to_dict()Serializable.to_json()Serializable.to_yaml()
SideEffect
- ads.common.utils module
FileOverwriteErrorJsonConverterbatch_convert_case()camel_to_snake()copy_file()copy_from_uri()download_from_web()ellipsis_strings()extract_lib_dependencies_from_model()first_not_none()flatten()folder_size()generate_requirement_file()get_base_modules()get_bootstrap_styles()get_compute_accelerator_ncores()get_cpu_count()get_dataframe_styles()get_files()get_oci_config()get_progress_bar()get_random_name_for_resource()get_sqlalchemy_engine()get_value()highlight_text()horizontal_scrollable_div()human_size()inject_and_copy_kwargs()is_data_too_wide()is_debug_mode()is_documentation_mode()is_notebook()is_resource_principal_mode()is_same_class()is_test()ml_task_typesnumeric_pandas_dtypes()oci_config_file()oci_config_location()oci_config_profile()oci_key_location()oci_key_profile()print_user_message()random_valid_ocid()remove_file()replace_spaces()set_oci_config()snake_to_camel()split_data()to_dataframe()truncate_series_top_n()wrap_lines()
- ads.common.word_lists module
- Module contents
- ads.data_labeling package
- Subpackages
- ads.data_labeling.interface package
- ads.data_labeling.loader package
- ads.data_labeling.mixin package
- ads.data_labeling.parser package
- ads.data_labeling.reader package
- Submodules
- ads.data_labeling.reader.dataset_reader module
- ads.data_labeling.reader.dls_record_reader module
- ads.data_labeling.reader.export_record_reader module
- ads.data_labeling.reader.jsonl_reader module
- ads.data_labeling.reader.metadata_reader module
- ads.data_labeling.reader.record_reader module
- Module contents
- ads.data_labeling.visualizer package
- Submodules
- ads.data_labeling.boundingbox module
BoundingBoxItemBoundingBoxItem.labelsBoundingBoxItem.top_leftBoundingBoxItem.bottom_leftBoundingBoxItem.bottom_rightBoundingBoxItem.top_rightBoundingBoxItem.bottom_leftBoundingBoxItem.bottom_rightBoundingBoxItem.from_yolo()BoundingBoxItem.labelsBoundingBoxItem.to_yolo()BoundingBoxItem.top_leftBoundingBoxItem.top_right
BoundingBoxItems
- ads.data_labeling.constants module
- ads.data_labeling.data_labeling_service module
- ads.data_labeling.metadata module
MetadataMetadata.source_pathMetadata.records_pathMetadata.labelsMetadata.dataset_nameMetadata.compartment_idMetadata.dataset_idMetadata.annotation_typeMetadata.dataset_typeMetadata.annotation_typeMetadata.compartment_idMetadata.dataset_idMetadata.dataset_nameMetadata.dataset_typeMetadata.from_dls_dataset()Metadata.labelsMetadata.records_pathMetadata.source_pathMetadata.to_dataframe()Metadata.to_dict()
- ads.data_labeling.ner module
- ads.data_labeling.record module
- Module contents
- Subpackages
- ads.database package
- ads.dataflow package
- ads.dataset package
- Submodules
- ads.dataset.classification_dataset module
- ads.dataset.correlation module
- ads.dataset.correlation_plot module
- ads.dataset.dask_series module
- ads.dataset.dataframe_transformer module
- ads.dataset.dataset module
ADSDatasetADSDataset.assign_column()ADSDataset.astype()ADSDataset.call()ADSDataset.compute()ADSDataset.corr()ADSDataset.ddfADSDataset.df_read_functionsADSDataset.drop_columns()ADSDataset.merge()ADSDataset.rename_columns()ADSDataset.sample()ADSDataset.set_description()ADSDataset.set_name()ADSDataset.set_target()ADSDataset.show_corr()ADSDataset.show_in_notebook()ADSDataset.snapshot()ADSDataset.to_avro()ADSDataset.to_csv()ADSDataset.to_dask()ADSDataset.to_dask_dataframe()ADSDataset.to_h2o()ADSDataset.to_h2o_dataframe()ADSDataset.to_hdf()ADSDataset.to_json()ADSDataset.to_pandas()ADSDataset.to_pandas_dataframe()ADSDataset.to_parquet()ADSDataset.to_xgb()ADSDataset.to_xgb_dmatrix()
- ads.dataset.dataset_browser module
- ads.dataset.dataset_with_target module
ADSDatasetWithTargetADSDatasetWithTarget.auto_transform()ADSDatasetWithTarget.get_recommendations()ADSDatasetWithTarget.get_transformed_dataset()ADSDatasetWithTarget.rename_columns()ADSDatasetWithTarget.select_best_features()ADSDatasetWithTarget.suggest_recommendations()ADSDatasetWithTarget.train_test_split()ADSDatasetWithTarget.train_validation_test_split()ADSDatasetWithTarget.type_of_target()ADSDatasetWithTarget.visualize_transforms()
- ads.dataset.exception module
- ads.dataset.factory module
CustomFormatReadersCustomFormatReaders.DEFAULT_SQL_ARRAYSIZECustomFormatReaders.DEFAULT_SQL_CHUNKSIZECustomFormatReaders.DEFAULT_SQL_CTUCustomFormatReaders.DEFAULT_SQL_MILCustomFormatReaders.read_arff()CustomFormatReaders.read_avro()CustomFormatReaders.read_html()CustomFormatReaders.read_json()CustomFormatReaders.read_libsvm()CustomFormatReaders.read_log()CustomFormatReaders.read_sql()CustomFormatReaders.read_tsv()CustomFormatReaders.read_xml()
DatasetFactoryget_format_reader()load_dataset()
- ads.dataset.feature_engineering_transformer module
- ads.dataset.feature_selection module
- ads.dataset.forecasting_dataset module
- ads.dataset.helper module
DatasetDefaultsDatasetLoadExceptionElaboratedPathcalculate_sample_size()concatenate()convert_columns()convert_to_html()deprecate_default_value()deprecate_variable()down_sample()fix_column_names()generate_sample()get_dtype()get_feature_type()get_fill_val()is_text_data()map_types()parse_apache_log_datetime()parse_apache_log_str()rename_duplicate_cols()up_sample()visualize_transformation()write_parquet()
- ads.dataset.label_encoder module
- ads.dataset.pipeline module
- ads.dataset.plot module
- ads.dataset.progress module
- ads.dataset.recommendation module
- ads.dataset.recommendation_transformer module
- ads.dataset.regression_dataset module
- ads.dataset.sampled_dataset module
- ads.dataset.target module
- ads.dataset.timeseries module
- Module contents
- ads.dbmixin package
- ads.environment package
- ads.evaluations package
- Submodules
- ads.evaluations.evaluation_plot module
EvaluationPlotEvaluationPlot.baselineEvaluationPlot.baseline_kwargsEvaluationPlot.color_wheelEvaluationPlot.font_szEvaluationPlot.perfectEvaluationPlot.perfect_kwargsEvaluationPlot.prob_typeEvaluationPlot.get_legend_labels()EvaluationPlot.plot()EvaluationPlot.baselineEvaluationPlot.baseline_kwargsEvaluationPlot.color_wheelEvaluationPlot.double_overlay_plotsEvaluationPlot.font_szEvaluationPlot.get_legend_labels()EvaluationPlot.perfectEvaluationPlot.perfect_kwargsEvaluationPlot.plot()EvaluationPlot.prob_typeEvaluationPlot.single_overlay_plots
- ads.evaluations.evaluator module
ADSEvaluatorADSEvaluator.evaluationsADSEvaluator.is_classifierADSEvaluator.legend_labelsADSEvaluator.metrics_to_showADSEvaluator.modelsADSEvaluator.positive_classADSEvaluator.show_full_nameADSEvaluator.test_dataADSEvaluator.training_dataADSEvaluator.Positive_Class_namesADSEvaluator.add_metrics()ADSEvaluator.del_metrics()ADSEvaluator.add_models()ADSEvaluator.del_models()ADSEvaluator.show_in_notebook()ADSEvaluator.calculate_cost()ADSEvaluator.EvaluationMetricsADSEvaluator.Positive_Class_NamesADSEvaluator.add_metrics()ADSEvaluator.add_models()ADSEvaluator.calculate_cost()ADSEvaluator.del_metrics()ADSEvaluator.del_models()ADSEvaluator.metricsADSEvaluator.raw_metricsADSEvaluator.show_in_notebook()
- ads.evaluations.statistical_metrics module
- Module contents
- ads.experiments package
- ads.feature_engineering package
- Subpackages
- ads.feature_engineering.accessor package
- ads.feature_engineering.adsimage package
- ads.feature_engineering.adsstring package
- ads.feature_engineering.dataset package
- ads.feature_engineering.feature_type package
- Subpackages
- Submodules
- ads.feature_engineering.feature_type.address module
- ads.feature_engineering.feature_type.base module
- ads.feature_engineering.feature_type.boolean module
- ads.feature_engineering.feature_type.category module
- ads.feature_engineering.feature_type.constant module
- ads.feature_engineering.feature_type.continuous module
- ads.feature_engineering.feature_type.creditcard module
- ads.feature_engineering.feature_type.datetime module
- ads.feature_engineering.feature_type.discrete module
- ads.feature_engineering.feature_type.document module
- ads.feature_engineering.feature_type.gis module
- ads.feature_engineering.feature_type.integer module
- ads.feature_engineering.feature_type.ip_address module
- ads.feature_engineering.feature_type.ip_address_v4 module
- ads.feature_engineering.feature_type.ip_address_v6 module
- ads.feature_engineering.feature_type.lat_long module
- ads.feature_engineering.feature_type.object module
- ads.feature_engineering.feature_type.ordinal module
- ads.feature_engineering.feature_type.phone_number module
- ads.feature_engineering.feature_type.string module
- ads.feature_engineering.feature_type.text module
- ads.feature_engineering.feature_type.unknown module
- ads.feature_engineering.feature_type.zip_code module
- Module contents
- Submodules
- ads.feature_engineering.exceptions module
- ads.feature_engineering.feature_type_manager module
- Classes
FeatureTypeManagerFeatureTypeManager.feature_type_object()FeatureTypeManager.feature_type_register()FeatureTypeManager.feature_type_unregister()FeatureTypeManager.feature_type_reset()FeatureTypeManager.feature_type_registered()FeatureTypeManager.warning_registered()FeatureTypeManager.validator_registered()FeatureTypeManager.feature_type_object()FeatureTypeManager.feature_type_register()FeatureTypeManager.feature_type_registered()FeatureTypeManager.feature_type_reset()FeatureTypeManager.feature_type_unregister()FeatureTypeManager.is_type_registered()FeatureTypeManager.validator_registered()FeatureTypeManager.warning_registered()
- ads.feature_engineering.schema module
AttributeBaseSchemaLoaderDataSizeTooWideDomainExpressionJsonSchemaLoaderSchemaSchema.add()Schema.from_dict()Schema.to_dict()Schema.to_yaml()Schema.to_json()Schema.to_json_file()Schema.to_yaml_file()Schema.add()Schema.add()Schema.from_dict()Schema.from_file()Schema.from_json()Schema.keysSchema.to_dict()Schema.to_json()Schema.to_json_file()Schema.to_yaml()Schema.to_yaml_file()Schema.validate_schema()Schema.validate_size()
SchemaFactorySchemaSizeTooLargeYamlSchemaLoader
- ads.feature_engineering.utils module
- Module contents
- Subpackages
- ads.hpo package
- Subpackages
- Submodules
- ads.hpo.ads_search_space module
DecisionTreeClassifierSearchSpaceDecisionTreeRegressorSearchSpaceElasticNetSearchSpaceExtraTreesClassifierSearchSpaceExtraTreesRegressorSearchSpaceGradientBoostingClassifierSearchSpaceGradientBoostingRegressorSearchSpaceLGBMClassifierSearchSpaceLGBMRegressorSearchSpaceLassoSearchSpaceLinearSVCSearchSpaceLinearSVRSearchSpaceLogisticRegressionSearchSpaceModelSearchSpaceRandomForestClassifierSearchSpaceRandomForestRegressorSearchSpaceRidgeClassifierSearchSpaceRidgeSearchSpaceSGDClassifierSearchSpaceSGDRegressorSearchSpaceSVCSearchSpaceSVRSearchSpaceXGBClassifierSearchSpaceXGBRegressorSearchSpaceget_model2searchspace()
- ads.hpo.distributions module
- ads.hpo.objective module
- ads.hpo.search_cv module
ADSTunerADSTuner.best_indexADSTuner.best_paramsADSTuner.best_scoreADSTuner.best_scores()ADSTuner.get_status()ADSTuner.halt()ADSTuner.is_completed()ADSTuner.is_halted()ADSTuner.is_running()ADSTuner.is_terminated()ADSTuner.n_trialsADSTuner.optimizer()ADSTuner.plot_best_scores()ADSTuner.plot_contour_scores()ADSTuner.plot_edf_scores()ADSTuner.plot_intermediate_scores()ADSTuner.plot_parallel_coordinate_scores()ADSTuner.plot_param_importance()ADSTuner.resume()ADSTuner.score_remainingADSTuner.scoring_nameADSTuner.search_space()ADSTuner.sklearn_stepsADSTuner.statusADSTuner.terminate()ADSTuner.time_elapsedADSTuner.time_remainingADSTuner.time_since_resumeADSTuner.trial_countADSTuner.trialsADSTuner.trials_export()ADSTuner.trials_import()ADSTuner.trials_remainingADSTuner.tune()ADSTuner.wait()
DuplicatedStudyErrorExitCriterionErrorInvalidStateTransitionNoRestartErrorState
- ads.hpo.stopping_criterion module
- ads.hpo.tuner_artifact module
- ads.hpo.utils module
- ads.hpo.validation module
- Module contents
- ads.jobs package
- ads.model package
- Subpackages
- ads.model.common package
- ads.model.deployment package
- ads.model.extractor package
- Submodules
- ads.model.extractor.keras_extractor module
- ads.model.extractor.lightgbm_extractor module
- ads.model.extractor.model_info_extractor module
- ads.model.extractor.model_info_extractor_factory module
- ads.model.extractor.pytorch_extractor module
- ads.model.extractor.sklearn_extractor module
- ads.model.extractor.spark_extractor module
- ads.model.extractor.tensorflow_extractor module
- ads.model.extractor.xgboost_extractor module
- Module contents
- ads.model.framework package
- Submodules
- ads.model.framework.lightgbm_model module
- ads.model.framework.pytorch_model module
- ads.model.framework.sklearn_model module
- ads.model.framework.spark_model module
- ads.model.framework.tensorflow_model module
- ads.model.framework.xgboost_model module
- ads.model.framework.huggingface_model module
- Module contents
- ads.model.model_artifact_boilerplate package
- ads.model.runtime package
- ads.model.service package
- ads.model.transformer package
- Submodules
- ads.model.artifact module
- ads.model.artifact_downloader module
- ads.model.artifact_uploader module
- ads.model.base_properties module
BasePropertiesBaseProperties.with_prop()BaseProperties.with_dict()BaseProperties.with_env()BaseProperties.to_dict()BaseProperties.with_config()BaseProperties.from_dict()BaseProperties.from_config()BaseProperties.to_config()BaseProperties.from_config()BaseProperties.from_dict()BaseProperties.to_config()BaseProperties.to_dict()BaseProperties.with_config()BaseProperties.with_dict()BaseProperties.with_env()BaseProperties.with_prop()
DataScienceModelTypeFrameworkSpecificModelGenericModelGenericModel.algorithmGenericModel.artifact_dirGenericModel.authGenericModel.estimatorGenericModel.frameworkGenericModel.hyperparameterGenericModel.metadata_customGenericModel.metadata_provenanceGenericModel.metadata_taxonomyGenericModel.model_artifactGenericModel.model_deploymentGenericModel.model_file_nameGenericModel.model_idGenericModel.propertiesGenericModel.runtime_infoGenericModel.schema_inputGenericModel.schema_outputGenericModel.serializeGenericModel.versionGenericModel.delete_deployment()GenericModel.deploy()GenericModel.from_model_artifact()GenericModel.from_model_catalog()GenericModel.from_model_deployment()GenericModel.update_deployment()GenericModel.from_id()GenericModel.introspect()GenericModel.predict()GenericModel.prepare()GenericModel.prepare_save_deploy()GenericModel.reload()GenericModel.restart_deployment()GenericModel.save()GenericModel.summary_status()GenericModel.verify()GenericModel.upload_artifact()GenericModel.delete()GenericModel.delete_deployment()GenericModel.deploy()GenericModel.from_id()GenericModel.from_model_artifact()GenericModel.from_model_catalog()GenericModel.from_model_deployment()GenericModel.get_data_serializer()GenericModel.introspect()GenericModel.metadata_customGenericModel.metadata_provenanceGenericModel.metadata_taxonomyGenericModel.model_deployment_idGenericModel.model_idGenericModel.predict()GenericModel.prepare()GenericModel.prepare_save_deploy()GenericModel.reload()GenericModel.reload_runtime_info()GenericModel.restart_deployment()GenericModel.save()GenericModel.schema_inputGenericModel.schema_outputGenericModel.serialize_model()GenericModel.summary_status()GenericModel.update()GenericModel.update_deployment()GenericModel.upload_artifact()GenericModel.verify()
ModelStateNotActiveDeploymentErrorRuntimeInfoInconsistencyErrorSerializeInputNotImplementedErrorSerializeModelNotImplementedErrorSummaryStatus
- ads.model.model_introspect module
- ads.model.model_metadata module
FrameworkFramework.BERTFramework.CUMLFramework.EMCEEFramework.ENSEMBLEFramework.FLAIRFramework.GENSIMFramework.H20Framework.KERASFramework.LIGHT_GBMFramework.MXNETFramework.NLTKFramework.ORACLE_AUTOMLFramework.OTHERFramework.PROPHETFramework.PYMC3Framework.PYODFramework.PYSTANFramework.PYTORCHFramework.SCIKIT_LEARNFramework.SKTIMEFramework.SPACYFramework.SPARKFramework.STATSMODELSFramework.TENSORFLOWFramework.TRANSFORMERSFramework.WORD2VECFramework.XGBOOST
MetadataCustomCategoryMetadataCustomKeysMetadataCustomKeys.CLIENT_LIBRARYMetadataCustomKeys.CONDA_ENVIRONMENTMetadataCustomKeys.CONDA_ENVIRONMENT_PATHMetadataCustomKeys.ENVIRONMENT_TYPEMetadataCustomKeys.MODEL_ARTIFACTSMetadataCustomKeys.MODEL_FILE_NAMEMetadataCustomKeys.MODEL_SERIALIZATION_FORMATMetadataCustomKeys.SLUG_NAMEMetadataCustomKeys.TRAINING_DATASETMetadataCustomKeys.TRAINING_DATASET_NUMBER_OF_COLSMetadataCustomKeys.TRAINING_DATASET_NUMBER_OF_ROWSMetadataCustomKeys.TRAINING_DATASET_SIZEMetadataCustomKeys.VALIDATION_DATASETMetadataCustomKeys.VALIDATION_DATASET_NUMBER_OF_COLSMetadataCustomKeys.VALIDATION_DATASET_NUMBER_OF_ROWSMetadataCustomKeys.VALIDATION_DATASET_SIZE
MetadataCustomPrintColumnsMetadataDescriptionTooLongMetadataSizeTooLargeMetadataTaxonomyKeysMetadataTaxonomyPrintColumnsMetadataValueTooLongModelCustomMetadataModelCustomMetadata.get()ModelCustomMetadata.reset()ModelCustomMetadata.to_dataframe()ModelCustomMetadata.size()ModelCustomMetadata.validate()ModelCustomMetadata.to_dict()ModelCustomMetadata.from_dict()ModelCustomMetadata.to_yaml()ModelCustomMetadata.add()ModelCustomMetadata.remove()ModelCustomMetadata.clear()ModelCustomMetadata.isempty()ModelCustomMetadata.to_json()ModelCustomMetadata.to_json_file()ModelCustomMetadata.add()ModelCustomMetadata.clear()ModelCustomMetadata.from_dict()ModelCustomMetadata.isempty()ModelCustomMetadata.remove()ModelCustomMetadata.set_training_data()ModelCustomMetadata.set_validation_data()ModelCustomMetadata.to_dataframe()
ModelCustomMetadataItemModelCustomMetadataItem.keyModelCustomMetadataItem.valueModelCustomMetadataItem.descriptionModelCustomMetadataItem.categoryModelCustomMetadataItem.reset()ModelCustomMetadataItem.to_dict()ModelCustomMetadataItem.from_dict()ModelCustomMetadataItem.to_yaml()ModelCustomMetadataItem.size()ModelCustomMetadataItem.update()ModelCustomMetadataItem.to_json()ModelCustomMetadataItem.to_json_file()ModelCustomMetadataItem.validate()ModelCustomMetadataItem.categoryModelCustomMetadataItem.descriptionModelCustomMetadataItem.reset()ModelCustomMetadataItem.update()ModelCustomMetadataItem.validate()
ModelMetadataModelMetadata.get()ModelMetadata.reset()ModelMetadata.to_dataframe()ModelMetadata.size()ModelMetadata.validate()ModelMetadata.to_dict()ModelMetadata.from_dict()ModelMetadata.to_yaml()ModelMetadata.to_json()ModelMetadata.to_json_file()ModelMetadata.from_dict()ModelMetadata.get()ModelMetadata.keysModelMetadata.reset()ModelMetadata.size()ModelMetadata.to_dataframe()ModelMetadata.to_dict()ModelMetadata.to_json()ModelMetadata.to_json_file()ModelMetadata.to_yaml()ModelMetadata.validate()ModelMetadata.validate_size()
ModelMetadataItemModelMetadataItem.to_dict()ModelMetadataItem.from_dict()ModelMetadataItem.to_yaml()ModelMetadataItem.size()ModelMetadataItem.to_json()ModelMetadataItem.to_json_file()ModelMetadataItem.validate()ModelMetadataItem.from_dict()ModelMetadataItem.size()ModelMetadataItem.to_dict()ModelMetadataItem.to_json()ModelMetadataItem.to_json_file()ModelMetadataItem.to_yaml()ModelMetadataItem.validate()
ModelProvenanceMetadataModelProvenanceMetadata.artifact_dirModelProvenanceMetadata.assert_path_not_dirty()ModelProvenanceMetadata.fetch_training_code_details()ModelProvenanceMetadata.from_dict()ModelProvenanceMetadata.git_branchModelProvenanceMetadata.git_commitModelProvenanceMetadata.repoModelProvenanceMetadata.repository_urlModelProvenanceMetadata.to_dict()ModelProvenanceMetadata.training_idModelProvenanceMetadata.training_script_path
ModelTaxonomyMetadataModelTaxonomyMetadata.get()ModelTaxonomyMetadata.reset()ModelTaxonomyMetadata.to_dataframe()ModelTaxonomyMetadata.size()ModelTaxonomyMetadata.validate()ModelTaxonomyMetadata.to_dict()ModelTaxonomyMetadata.from_dict()ModelTaxonomyMetadata.to_yaml()ModelTaxonomyMetadata.to_json()ModelTaxonomyMetadata.to_json_file()ModelTaxonomyMetadata.from_dict()ModelTaxonomyMetadata.to_dataframe()
ModelTaxonomyMetadataItemModelTaxonomyMetadataItem.keyModelTaxonomyMetadataItem.valueModelTaxonomyMetadataItem.reset()ModelTaxonomyMetadataItem.to_dict()ModelTaxonomyMetadataItem.from_dict()ModelTaxonomyMetadataItem.to_yaml()ModelTaxonomyMetadataItem.size()ModelTaxonomyMetadataItem.update()ModelTaxonomyMetadataItem.to_json()ModelTaxonomyMetadataItem.to_json_file()ModelTaxonomyMetadataItem.validate()ModelTaxonomyMetadataItem.keyModelTaxonomyMetadataItem.reset()ModelTaxonomyMetadataItem.update()ModelTaxonomyMetadataItem.validate()ModelTaxonomyMetadataItem.value
UseCaseTypeUseCaseType.ANOMALY_DETECTIONUseCaseType.BINARY_CLASSIFICATIONUseCaseType.CLUSTERINGUseCaseType.DIMENSIONALITY_REDUCTIONUseCaseType.IMAGE_CLASSIFICATIONUseCaseType.MULTINOMIAL_CLASSIFICATIONUseCaseType.NERUseCaseType.OBJECT_LOCALIZATIONUseCaseType.OTHERUseCaseType.RECOMMENDERUseCaseType.REGRESSIONUseCaseType.SENTIMENT_ANALYSISUseCaseType.TIME_SERIES_FORECASTINGUseCaseType.TOPIC_MODELING
- ads.model.model_metadata_mixin module
- ads.model.model_properties module
ModelPropertiesModelProperties.bucket_uriModelProperties.compartment_idModelProperties.deployment_access_log_idModelProperties.deployment_bandwidth_mbpsModelProperties.deployment_instance_countModelProperties.deployment_instance_shapeModelProperties.deployment_log_group_idModelProperties.deployment_memory_in_gbsModelProperties.deployment_ocpusModelProperties.deployment_predict_log_idModelProperties.inference_conda_envModelProperties.inference_python_versionModelProperties.overwrite_existing_artifactModelProperties.project_idModelProperties.remove_existing_artifactModelProperties.training_conda_envModelProperties.training_idModelProperties.training_python_versionModelProperties.training_resource_idModelProperties.training_script_path
- ads.model.model_version_set module
ModelVersionSetModelVersionSet.idModelVersionSet.project_idModelVersionSet.compartment_idModelVersionSet.nameModelVersionSet.descriptionModelVersionSet.freeform_tagsModelVersionSet.defined_tagsModelVersionSet.details_linkModelVersionSet.create()ModelVersionSet.update()ModelVersionSet.delete()ModelVersionSet.to_dict()ModelVersionSet.from_id()ModelVersionSet.from_ocid()ModelVersionSet.from_name()ModelVersionSet.from_dict()ModelVersionSet.CONST_COMPARTMENT_IDModelVersionSet.CONST_DEFINED_TAGModelVersionSet.CONST_DESCRIPTIONModelVersionSet.CONST_FREEFORM_TAGModelVersionSet.CONST_IDModelVersionSet.CONST_NAMEModelVersionSet.CONST_PROJECT_IDModelVersionSet.LIFECYCLE_STATE_ACTIVEModelVersionSet.LIFECYCLE_STATE_DELETEDModelVersionSet.LIFECYCLE_STATE_DELETINGModelVersionSet.LIFECYCLE_STATE_FAILEDModelVersionSet.attribute_mapModelVersionSet.compartment_idModelVersionSet.create()ModelVersionSet.defined_tagsModelVersionSet.delete()ModelVersionSet.descriptionModelVersionSet.details_linkModelVersionSet.freeform_tagsModelVersionSet.from_dict()ModelVersionSet.from_dsc_model_version_set()ModelVersionSet.from_id()ModelVersionSet.from_name()ModelVersionSet.from_ocid()ModelVersionSet.idModelVersionSet.kindModelVersionSet.list()ModelVersionSet.model_add()ModelVersionSet.models()ModelVersionSet.nameModelVersionSet.project_idModelVersionSet.statusModelVersionSet.to_dict()ModelVersionSet.update()ModelVersionSet.with_compartment_id()ModelVersionSet.with_defined_tags()ModelVersionSet.with_description()ModelVersionSet.with_freeform_tags()ModelVersionSet.with_name()ModelVersionSet.with_project_id()
experiment()
- Module contents
- Subpackages
- ads.model_artifact_boilerplate package
- ads.mysqldb package
- ads.opctl package
- Subpackages
- Submodules
- ads.opctl.cli module
- ads.opctl.cmds module
- ads.opctl.constants module
- ads.opctl.utils module
- Module contents
- ads.oracledb package
- ads.pipeline package
- Subpackages
- Submodules
- ads.pipeline.ads_pipeline module
DataSciencePipelinePipelinePipeline.kindPipeline.namePipeline.idPipeline.step_detailsPipeline.dag_detailsPipeline.log_group_idPipeline.log_idPipeline.project_idPipeline.compartment_idPipeline.created_byPipeline.descriptionPipeline.environment_variablePipeline.argumentPipeline.maximum_runtime_in_minutesPipeline.shape_namePipeline.block_storage_size_in_gbsPipeline.shape_config_detailsPipeline.enable_service_logPipeline.service_log_idPipeline.statusPipeline.with_name()Pipeline.with_id()Pipeline.with_step_details()Pipeline.with_dag_details()Pipeline.with_log_group_id()Pipeline.with_log_id()Pipeline.with_project_id()Pipeline.with_compartment_id()Pipeline.with_created_by()Pipeline.with_description()Pipeline.with_environment_variable()Pipeline.with_argument()Pipeline.with_maximum_runtime_in_minutes()Pipeline.with_freeform_tags()Pipeline.with_defined_tags()Pipeline.with_shape_name()Pipeline.with_block_storage_size_in_gbs()Pipeline.with_shape_config_details()Pipeline.with_enable_service_log()Pipeline.to_dict()Pipeline.create()Pipeline.show()Pipeline.to_svg()Pipeline.run()Pipeline.delete()Pipeline.from_ocid()Pipeline.from_id()Pipeline.to_yaml()Pipeline.from_yaml()Pipeline.list()Pipeline.run_list()Pipeline.CONST_BLOCK_STORAGE_SIZEPipeline.CONST_COMMAND_LINE_ARGUMENTSPipeline.CONST_COMPARTMENT_IDPipeline.CONST_CONFIGURATION_DETAILSPipeline.CONST_CONFIGURATION_OVERRIDE_DETAILSPipeline.CONST_CREATED_BYPipeline.CONST_DAGPipeline.CONST_DEFINED_TAGSPipeline.CONST_DESCRIPTIONPipeline.CONST_DISPLAY_NAMEPipeline.CONST_ENABLE_AUTO_LOG_CREATIONPipeline.CONST_ENABLE_LOGGINGPipeline.CONST_ENABLE_SERVICE_LOGPipeline.CONST_ENVIRONMENT_VARIABLESPipeline.CONST_FREEFROM_TAGSPipeline.CONST_IDPipeline.CONST_INFRA_CONFIG_DETAILSPipeline.CONST_LOG_CONFIGURATION_DETAILSPipeline.CONST_LOG_CONFIGURATION_OVERRIDE_DETAILSPipeline.CONST_LOG_GROUP_IDPipeline.CONST_LOG_IDPipeline.CONST_MAXIMUM_RUNTIME_IN_MINUTESPipeline.CONST_MEMORY_IN_GBSPipeline.CONST_OCPUSPipeline.CONST_PIPELINE_IDPipeline.CONST_PROJECT_IDPipeline.CONST_SERVICEPipeline.CONST_SERVICE_LOG_CATEGORYPipeline.CONST_SERVICE_LOG_IDPipeline.CONST_SHAPE_CONFIG_DETAILSPipeline.CONST_SHAPE_NAMEPipeline.CONST_STEP_DETAILSPipeline.CONST_STEP_OVERRIDE_DETAILSPipeline.CONST_SYSTEM_TAGSPipeline.CONST_TYPEPipeline.LIFECYCLE_STATE_ACTIVEPipeline.LIFECYCLE_STATE_CREATINGPipeline.LIFECYCLE_STATE_DELETEDPipeline.LIFECYCLE_STATE_DELETINGPipeline.LIFECYCLE_STATE_FAILEDPipeline.argumentPipeline.block_storage_size_in_gbsPipeline.compartment_idPipeline.create()Pipeline.created_byPipeline.dagPipeline.delete()Pipeline.descriptionPipeline.download()Pipeline.enable_service_logPipeline.environment_variablePipeline.from_dict()Pipeline.from_id()Pipeline.from_ocid()Pipeline.idPipeline.kindPipeline.list()Pipeline.log_group_idPipeline.log_idPipeline.maximum_runtime_in_minutesPipeline.namePipeline.project_idPipeline.run()Pipeline.run_list()Pipeline.service_log_idPipeline.shape_config_detailsPipeline.shape_namePipeline.show()Pipeline.statusPipeline.step_detailsPipeline.to_dict()Pipeline.to_svg()Pipeline.with_argument()Pipeline.with_block_storage_size_in_gbs()Pipeline.with_compartment_id()Pipeline.with_created_by()Pipeline.with_dag()Pipeline.with_defined_tags()Pipeline.with_description()Pipeline.with_enable_service_log()Pipeline.with_environment_variable()Pipeline.with_freeform_tags()Pipeline.with_id()Pipeline.with_log_group_id()Pipeline.with_log_id()Pipeline.with_maximum_runtime_in_minutes()Pipeline.with_name()Pipeline.with_project_id()Pipeline.with_shape_config_details()Pipeline.with_shape_name()Pipeline.with_step_details()
- ads.pipeline.ads_pipeline_run module
LogNotConfiguredErrorLogTypePipelineRunPipelineRun.pipelinePipelineRun.statusPipelineRun.custom_loggingPipelineRun.create()PipelineRun.delete()PipelineRun.cancel()PipelineRun.watch()PipelineRun.list()PipelineRun.to_yaml()PipelineRun.show()PipelineRun.to_svg()PipelineRun.sync()PipelineRun.cancel()PipelineRun.create()PipelineRun.custom_loggingPipelineRun.delete()PipelineRun.list()PipelineRun.logs()PipelineRun.pipelinePipelineRun.service_loggingPipelineRun.show()PipelineRun.statusPipelineRun.sync()PipelineRun.to_svg()PipelineRun.to_yaml()PipelineRun.watch()
ShowModeStepType
- ads.pipeline.ads_pipeline_step module
PipelineStepPipelineStep.kindPipelineStep.namePipelineStep.job_idPipelineStep.infrastructurePipelineStep.runtimePipelineStep.descriptionPipelineStep.maximum_runtime_in_minutesPipelineStep.environment_variablePipelineStep.argumentPipelineStep.depends_onPipelineStep.with_job_id()PipelineStep.with_infrastructure()PipelineStep.with_runtime()PipelineStep.with_description()PipelineStep.with_maximum_runtime_in_minutes()PipelineStep.with_environment_variable()PipelineStep.with_argument()PipelineStep.with_kind()PipelineStep.to_dict()PipelineStep.from_dict()PipelineStep.to_yaml()PipelineStep.from_yaml()PipelineStep.CONST_COMMAND_LINE_ARGUMENTSPipelineStep.CONST_DEPENDS_ONPipelineStep.CONST_DESCRIPTIONPipelineStep.CONST_ENVIRONMENT_VARIABLESPipelineStep.CONST_INFRASTRUCTUREPipelineStep.CONST_JOB_IDPipelineStep.CONST_KINDPipelineStep.CONST_MAXIMUM_RUNTIME_IN_MINUTESPipelineStep.CONST_NAMEPipelineStep.CONST_RUNTIMEPipelineStep.CONST_STEP_CONFIG_DETAILSPipelineStep.CONST_STEP_INFRA_CONFIG_DETAILSPipelineStep.argumentPipelineStep.depends_onPipelineStep.descriptionPipelineStep.environment_variablePipelineStep.from_dict()PipelineStep.infrastructurePipelineStep.job_idPipelineStep.kindPipelineStep.maximum_runtime_in_minutesPipelineStep.namePipelineStep.runtimePipelineStep.to_dict()PipelineStep.with_argument()PipelineStep.with_description()PipelineStep.with_environment_variable()PipelineStep.with_infrastructure()PipelineStep.with_job_id()PipelineStep.with_kind()PipelineStep.with_maximum_runtime_in_minutes()PipelineStep.with_runtime()
- ads.pipeline.cli module
- ads.pipeline.extension module
- Module contents
- ads.secrets package
- Submodules
- ads.secrets.adb module
- ads.secrets.auth_token module
- ads.secrets.big_data_service module
BDSSecretBDSSecret.principalBDSSecret.hdfs_hostBDSSecret.hive_hostBDSSecret.hdfs_portBDSSecret.hive_portBDSSecret.kerb5_pathBDSSecret.kerb5_contentBDSSecret.keytab_pathBDSSecret.keytab_contentBDSSecret.secret_idBDSSecret.hdfs_hostBDSSecret.hdfs_portBDSSecret.hive_hostBDSSecret.hive_portBDSSecret.kerb5_contentBDSSecret.kerb5_pathBDSSecret.keytab_contentBDSSecret.keytab_pathBDSSecret.principalBDSSecret.secret_id
BDSSecretKeeperBDSSecretKeeper.principalBDSSecretKeeper.hdfs_hostBDSSecretKeeper.hive_hostBDSSecretKeeper.hdfs_portBDSSecretKeeper.hive_portBDSSecretKeeper.kerb5_pathBDSSecretKeeper.kerb5_contentBDSSecretKeeper.keytab_pathBDSSecretKeeper.keytab_contentBDSSecretKeeper.secret_idBDSSecretKeeper.kwargsBDSSecretKeeper.vault_idBDSSecretKeeper.key_idBDSSecretKeeper.compartment_idBDSSecretKeeper.authBDSSecretKeeper.decode()BDSSecretKeeper.encode()BDSSecretKeeper.save()
- ads.secrets.mysqldb module
- ads.secrets.oracledb module
- ads.secrets.secrets module
- Module contents
- ads.telemetry package
- ads.text_dataset package
- ads.type_discovery package
- Submodules
- ads.type_discovery.abstract_detector module
- ads.type_discovery.constant_detector module
- ads.type_discovery.continuous_detector module
- ads.type_discovery.credit_card_detector module
- ads.type_discovery.datetime_detector module
- ads.type_discovery.discrete_detector module
- ads.type_discovery.document_detector module
- ads.type_discovery.ip_detector module
- ads.type_discovery.latlon_detector module
- ads.type_discovery.phone_number_detector module
- ads.type_discovery.type_discovery_driver module
- ads.type_discovery.typed_feature module
AddressTypedFeatureCategoricalTypedFeatureConstantTypedFeatureContinuousTypedFeatureCreditCardTypedFeatureDateTimeTypedFeatureDiscreteTypedFeatureDocumentTypedFeatureGISTypedFeatureIPAddressTypedFeatureOrdinalTypedFeaturePhoneNumberTypedFeatureTypedFeatureUnknownTypedFeatureZipcodeTypedFeature
- ads.type_discovery.unknown_detector module
- ads.type_discovery.zipcode_detector module
- Module contents
- ads.vault package
Submodules
ads.cli module
ads.config module
- ads.config.open(uri: Optional[str] = '~/.ads/config', profile: Optional[str] = 'DEFAULT', mode: Optional[str] = 'r', auth: Dict = None)
Context manager helping to read and write config files.
- Parameters:
uri ((str, optional). Defaults to ~/.ads/config.) – The path to the config file. Can be local or Object Storage file.
profile ((str, optional). Defaults to DEFAULT) – The name of the profile to be loaded.
mode ((str, optional). Defaults to r.) – The config mode. Supported values: [‘r’, ‘w’]
auth ((Dict, optional). Defaults to None.) – The default authetication is set using ads.set_auth API. If you need to override the default, use the ads.common.auth.api_keys or ads.common.auth.resource_principal to create appropriate authentication signer and kwargs required to instantiate IdentityClient object.
- Yields:
ConfigSection – The config section object.
Module contents
- ads.getLogger(name='ads')
- ads.hello()
Imports Pandas, sets the documentation mode, and prints a fancy “Hello”.
- ads.set_debug_mode(mode=True)
Enable/disable printing stack traces on notebook.
- Parameters:
mode (bool (default True)) – Enable/disable print stack traces on notebook
- ads.set_documentation_mode(mode=False)
This method is deprecated and will be removed in future releases. Enable/disable printing user tips on notebook.
- Parameters:
mode (bool (default False)) – Enable/disable print user tips on notebook
- ads.set_expert_mode()
This method is deprecated and will be removed in future releases. Enables the debug and documentation mode for expert users all in one method.