ads package
Subpackages
- ads.automl package
- Submodules
- ads.automl.driver module
- ads.automl.provider module
AutoMLFeatureSelectionAutoMLPreprocessingTransformerAutoMLProviderBaselineAutoMLProviderBaselineModelOracleAutoMLProviderOracleAutoMLProvider.get_transformer_pipeline()OracleAutoMLProvider.print_summary()OracleAutoMLProvider.print_trials()OracleAutoMLProvider.selected_model_name()OracleAutoMLProvider.selected_score_label()OracleAutoMLProvider.train()OracleAutoMLProvider.visualize_adaptive_sampling_trials()OracleAutoMLProvider.visualize_algorithm_selection_trials()OracleAutoMLProvider.visualize_feature_selection_trials()OracleAutoMLProvider.visualize_tuning_trials()
- Module contents
- 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
- Submodules
- ads.common.card_identifier module
- ads.common.auth module
- ads.common.data 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_metadata module
- ads.common.decorator.runtime_dependency module
OptionalDependencyOptionalDependency.BDSOptionalDependency.BOOSTEDOptionalDependency.DATAOptionalDependency.GEOOptionalDependency.LABSOptionalDependency.MYSQLOptionalDependency.NOTEBOOKOptionalDependency.ONNXOptionalDependency.OPCTLOptionalDependency.OPTUNAOptionalDependency.PYTORCHOptionalDependency.SPARKOptionalDependency.TENSORFLOWOptionalDependency.TEXTOptionalDependency.VIZ
runtime_dependency()
- ads.common.decorator.deprecate module
- ads.common.model_introspect module
- ads.common.model_export_util module
- ads.common.function.fn_util module
- 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()
- Module contents
- ads.common.model_metadata_mixin module
- ads.bds package
- ads.data_labeling package
- Submodules
- ads.data_labeling.interface.loader module
- ads.data_labeling.interface.parser module
- ads.data_labeling.interface.reader module
- 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
- ads.data_labeling.mixin.data_labeling module
- ads.data_labeling.parser.export_metadata_parser module
- ads.data_labeling.parser.export_record_parser module
- ads.data_labeling.reader.dataset_reader module
- ads.data_labeling.reader.jsonl_reader module
- ads.data_labeling.reader.metadata_reader module
- ads.data_labeling.reader.record_reader module
- ads.data_labeling.visualizer.image_visualizer module
- ads.data_labeling.visualizer.text_visualizer module
- Module contents
- 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.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.EvaluationMetrics.ev_testADSEvaluator.EvaluationMetrics.ev_trainADSEvaluator.EvaluationMetrics.use_trainingADSEvaluator.EvaluationMetrics.less_is_moreADSEvaluator.EvaluationMetrics.show_in_notebook()ADSEvaluator.EvaluationMetrics.DEFAULT_LABELS_MAPADSEvaluator.EvaluationMetrics.precisionADSEvaluator.EvaluationMetrics.show_in_notebook()
ADSEvaluator.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.explanations package
- ads.feature_engineering package
- 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.accessor.dataframe_accessor module
ADSDataFrameAccessorADSDataFrameAccessor.columnsADSDataFrameAccessor.tagsADSDataFrameAccessor.default_typeADSDataFrameAccessor.feature_typeADSDataFrameAccessor.feature_type_descriptionADSDataFrameAccessor.sync()ADSDataFrameAccessor.feature_select()ADSDataFrameAccessor.help()ADSDataFrameAccessor.default_typeADSDataFrameAccessor.feature_select()ADSDataFrameAccessor.feature_typeADSDataFrameAccessor.feature_type_descriptionADSDataFrameAccessor.info()ADSDataFrameAccessor.model_schema()ADSDataFrameAccessor.sync()ADSDataFrameAccessor.tags
- ads.feature_engineering.accessor.series_accessor module
ADSSeriesAccessorADSSeriesAccessor.nameADSSeriesAccessor.tagsADSSeriesAccessor.help()ADSSeriesAccessor.sync()ADSSeriesAccessor.default_typeADSSeriesAccessor.feature_typeADSSeriesAccessor.feature_type_descriptionADSSeriesAccessor.default_typeADSSeriesAccessor.feature_typeADSSeriesAccessor.feature_type_descriptionADSSeriesAccessor.sync()
ADSSeriesValidator
- ads.feature_engineering.accessor.mixin.correlation module
- ads.feature_engineering.accessor.mixin.eda_mixin module
- ads.feature_engineering.accessor.mixin.eda_mixin_series module
- ads.feature_engineering.accessor.mixin.feature_types_mixin module
- ads.feature_engineering.adsstring.common_regex_mixin module
CommonRegexMixinCommonRegexMixin.addressCommonRegexMixin.credit_cardCommonRegexMixin.dateCommonRegexMixin.emailCommonRegexMixin.ipCommonRegexMixin.linkCommonRegexMixin.phone_number_USCommonRegexMixin.priceCommonRegexMixin.redact()CommonRegexMixin.redact_mapCommonRegexMixin.ssnCommonRegexMixin.timeCommonRegexMixin.zip_code
- ads.feature_engineering.adsstring.oci_language module
- ads.feature_engineering.adsstring.string module
- 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
- ads.feature_engineering.feature_type.handler.feature_validator module
- ads.feature_engineering.feature_type.handler.feature_warning module
- ads.feature_engineering.feature_type.handler.warnings module
- Module contents
- ads.hpo package
- Submodules
- ads.hpo.distributions 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 contents
- ads.jobs package
- Submodules
- ads.jobs.ads_job module
JobJob.create()Job.dataflow_job()Job.datascience_job()Job.delete()Job.download()Job.from_dataflow_job()Job.from_datascience_job()Job.from_dict()Job.idJob.infrastructureJob.kindJob.nameJob.run()Job.run_list()Job.runtimeJob.status()Job.to_dict()Job.with_infrastructure()Job.with_name()Job.with_runtime()
- ads.jobs.builders.runtimes.python_runtime module
CondaRuntimeCondaRuntime.CONST_CONDACondaRuntime.CONST_CONDA_REGIONCondaRuntime.CONST_CONDA_SLUGCondaRuntime.CONST_CONDA_TYPECondaRuntime.CONST_CONDA_TYPE_CUSTOMCondaRuntime.CONST_CONDA_TYPE_SERVICECondaRuntime.CONST_CONDA_URICondaRuntime.attribute_mapCondaRuntime.condaCondaRuntime.with_custom_conda()CondaRuntime.with_service_conda()
DataFlowNotebookRuntimeDataFlowRuntimeDataFlowRuntime.CONST_ARCHIVE_BUCKETDataFlowRuntime.CONST_ARCHIVE_URIDataFlowRuntime.CONST_CONDA_AUTH_TYPEDataFlowRuntime.CONST_CONFIGURATIONDataFlowRuntime.CONST_SCRIPT_BUCKETDataFlowRuntime.CONST_SCRIPT_PATHDataFlowRuntime.archive_bucketDataFlowRuntime.archive_uriDataFlowRuntime.attribute_mapDataFlowRuntime.configurationDataFlowRuntime.convert()DataFlowRuntime.script_bucketDataFlowRuntime.script_uriDataFlowRuntime.with_archive_bucket()DataFlowRuntime.with_archive_uri()DataFlowRuntime.with_conda()DataFlowRuntime.with_configuration()DataFlowRuntime.with_custom_conda()DataFlowRuntime.with_script_bucket()DataFlowRuntime.with_script_uri()DataFlowRuntime.with_service_conda()
GitPythonRuntimeGitPythonRuntime.CONST_BRANCHGitPythonRuntime.CONST_COMMITGitPythonRuntime.CONST_GIT_SSH_SECRET_IDGitPythonRuntime.CONST_GIT_URLGitPythonRuntime.CONST_SKIP_METADATAGitPythonRuntime.attribute_mapGitPythonRuntime.branchGitPythonRuntime.commitGitPythonRuntime.skip_metadata_updateGitPythonRuntime.ssh_secret_ocidGitPythonRuntime.urlGitPythonRuntime.with_argument()GitPythonRuntime.with_source()
NotebookRuntimeNotebookRuntime.CONST_EXCLUDE_TAGNotebookRuntime.CONST_NOTEBOOK_ENCODINGNotebookRuntime.CONST_NOTEBOOK_PATHNotebookRuntime.CONST_OUTPUT_URINotebookRuntime.attribute_mapNotebookRuntime.exclude_tagNotebookRuntime.notebook_encodingNotebookRuntime.notebook_uriNotebookRuntime.output_uriNotebookRuntime.with_exclude_tag()NotebookRuntime.with_notebook()NotebookRuntime.with_output()
PythonRuntimeScriptRuntime
- ads.jobs.builders.infrastructure.dataflow module
DataFlowDataFlow.CONST_BUCKET_URIDataFlow.CONST_COMPARTMENT_IDDataFlow.CONST_CONFIGDataFlow.CONST_DRIVER_SHAPEDataFlow.CONST_DRIVER_SHAPE_CONFIGDataFlow.CONST_EXECUTEDataFlow.CONST_EXECUTOR_SHAPEDataFlow.CONST_EXECUTOR_SHAPE_CONFIGDataFlow.CONST_IDDataFlow.CONST_LANGUAGEDataFlow.CONST_MEMORY_IN_GBSDataFlow.CONST_METASTORE_IDDataFlow.CONST_NUM_EXECUTORSDataFlow.CONST_OCPUSDataFlow.CONST_SPARK_VERSIONDataFlow.CONST_WAREHOUSE_BUCKET_URIDataFlow.attribute_mapDataFlow.create()DataFlow.delete()DataFlow.from_dict()DataFlow.from_id()DataFlow.job_idDataFlow.list_jobs()DataFlow.nameDataFlow.run()DataFlow.run_list()DataFlow.to_dict()DataFlow.to_yaml()DataFlow.with_compartment_id()DataFlow.with_configuration()DataFlow.with_driver_shape()DataFlow.with_driver_shape_config()DataFlow.with_execute()DataFlow.with_executor_shape()DataFlow.with_executor_shape_config()DataFlow.with_id()DataFlow.with_language()DataFlow.with_logs_bucket_uri()DataFlow.with_metastore_id()DataFlow.with_num_executors()DataFlow.with_spark_version()DataFlow.with_warehouse_bucket_uri()
DataFlowAppDataFlowLogsDataFlowRunconda_pack_name_to_dataflow_config()
- ads.jobs.builders.infrastructure.dsc_job module
DSCJobDSCJobRunDataScienceJobDataScienceJob.CONST_BLOCK_STORAGEDataScienceJob.CONST_COMPARTMENT_IDDataScienceJob.CONST_DISPLAY_NAMEDataScienceJob.CONST_JOB_INFRADataScienceJob.CONST_JOB_TYPEDataScienceJob.CONST_LOG_GROUP_IDDataScienceJob.CONST_LOG_IDDataScienceJob.CONST_MEMORY_IN_GBSDataScienceJob.CONST_OCPUSDataScienceJob.CONST_PROJECT_IDDataScienceJob.CONST_SHAPE_CONFIG_DETAILSDataScienceJob.CONST_SHAPE_NAMEDataScienceJob.CONST_SUBNET_IDDataScienceJob.attribute_mapDataScienceJob.block_storage_sizeDataScienceJob.compartment_idDataScienceJob.create()DataScienceJob.delete()DataScienceJob.from_dsc_job()DataScienceJob.from_id()DataScienceJob.instance_shapes()DataScienceJob.job_idDataScienceJob.job_infrastructure_typeDataScienceJob.job_typeDataScienceJob.list_jobs()DataScienceJob.log_group_idDataScienceJob.log_idDataScienceJob.nameDataScienceJob.payload_attribute_mapDataScienceJob.project_idDataScienceJob.run()DataScienceJob.run_list()DataScienceJob.shape_config_detailsDataScienceJob.shape_config_details_attribute_mapDataScienceJob.shape_nameDataScienceJob.snake_to_camel_mapDataScienceJob.standardize_spec()DataScienceJob.statusDataScienceJob.subnet_idDataScienceJob.with_block_storage_size()DataScienceJob.with_compartment_id()DataScienceJob.with_job_infrastructure_type()DataScienceJob.with_job_type()DataScienceJob.with_log_group_id()DataScienceJob.with_log_id()DataScienceJob.with_project_id()DataScienceJob.with_shape_config_details()DataScienceJob.with_shape_name()DataScienceJob.with_subnet_id()
DataScienceJobRunDataScienceJobRun.TERMINAL_STATESDataScienceJobRun.cancel()DataScienceJobRun.create()DataScienceJobRun.download()DataScienceJobRun.jobDataScienceJobRun.log_group_idDataScienceJobRun.log_idDataScienceJobRun.loggingDataScienceJobRun.logs()DataScienceJobRun.statusDataScienceJobRun.to_yaml()DataScienceJobRun.watch()
- Module contents
- ads.model.framework other package
- Submodules
- ads.model.artifact module
- ads.model.generic_model module
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_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.runtime.runtime_info module
- ads.model.extractor.model_info_extractor_factory module
- ads.model.extractor.model_artifact module
- ads.model.extractor.automl_extractor module
- ads.model.extractor.xgboost_extractor module
- ads.model.extractor.lightgbm_extractor module
- ads.model.extractor.model_info_extractor module
ModelInfoExtractorModelInfoExtractor.framework()ModelInfoExtractor.algorithm()ModelInfoExtractor.version()ModelInfoExtractor.hyperparameter()ModelInfoExtractor.info()ModelInfoExtractor.algorithm()ModelInfoExtractor.framework()ModelInfoExtractor.hyperparameter()ModelInfoExtractor.info()ModelInfoExtractor.version()
normalize_hyperparameter()
- ads.model.extractor.sklearn_extractor module
- ads.model.extractor.keras_extractor module
- ads.model.extractor.tensorflow_extractor module
TensorflowExtractorTensorflowExtractor.modelTensorflowExtractor.estimatorTensorflowExtractor.framework()TensorflowExtractor.algorithm()TensorflowExtractor.version()TensorflowExtractor.hyperparameter()TensorflowExtractor.algorithmTensorflowExtractor.frameworkTensorflowExtractor.hyperparameterTensorflowExtractor.version
- ads.model.extractor.pytorch_extractor module
- Module contents
- ads.model.deployment package
- Submodules
- ads.model.deployment.model_deployer module
ModelDeployerModelDeployer.configModelDeployer.ds_clientModelDeployer.ds_composite_clientModelDeployer.deploy()ModelDeployer.get_model_deployment()ModelDeployer.get_model_deployment_state()ModelDeployer.delete()ModelDeployer.list_deployments()ModelDeployer.show_deployments()ModelDeployer.delete()ModelDeployer.deploy()ModelDeployer.deploy_from_model_uri()ModelDeployer.get_model_deployment()ModelDeployer.get_model_deployment_state()ModelDeployer.list_deployments()ModelDeployer.show_deployments()ModelDeployer.update()
- ads.model.deployment.model_deployment module
LogNotConfiguredErrorModelDeploymentModelDeployment.configModelDeployment.propertiesModelDeployment.workflow_state_progressModelDeployment.workflow_stepsModelDeployment.urlModelDeployment.ds_clientModelDeployment.ds_composite_clientModelDeployment.workflow_req_idModelDeployment.model_deployment_idModelDeployment.stateModelDeployment.deploy()ModelDeployment.delete()ModelDeployment.update()ModelDeployment.activate()ModelDeployment.deactivate()ModelDeployment.list_workflow_logs()ModelDeployment.access_logModelDeployment.activate()ModelDeployment.deactivate()ModelDeployment.delete()ModelDeployment.deploy()ModelDeployment.list_workflow_logs()ModelDeployment.logs()ModelDeployment.predict()ModelDeployment.predict_logModelDeployment.show_logs()ModelDeployment.stateModelDeployment.statusModelDeployment.update()
ModelDeploymentLogType
- ads.model.deployment.model_deployment_properties module
ModelDeploymentPropertiesModelDeploymentProperties.swagger_typesModelDeploymentProperties.model_idModelDeploymentProperties.model_uriModelDeploymentProperties.with_prop()ModelDeploymentProperties.with_instance_configuration()ModelDeploymentProperties.with_access_log()ModelDeploymentProperties.with_predict_log()ModelDeploymentProperties.build()ModelDeploymentProperties.build()ModelDeploymentProperties.sub_propertiesModelDeploymentProperties.to_oci_model()ModelDeploymentProperties.to_update_deployment()ModelDeploymentProperties.with_access_log()ModelDeploymentProperties.with_category_log()ModelDeploymentProperties.with_instance_configuration()ModelDeploymentProperties.with_logging_configuration()ModelDeploymentProperties.with_predict_log()ModelDeploymentProperties.with_prop()
- Module contents
- ads.model.framework package
- Submodules
- ads.model.framework.automl_model module
AutoMLModelAutoMLModel.algorithmAutoMLModel.artifact_dirAutoMLModel.authAutoMLModel.ds_clientAutoMLModel.estimatorAutoMLModel.frameworkAutoMLModel.hyperparameterAutoMLModel.metadata_customAutoMLModel.metadata_provenanceAutoMLModel.metadata_taxonomyAutoMLModel.model_artifactAutoMLModel.model_deploymentAutoMLModel.model_file_nameAutoMLModel.model_idAutoMLModel.propertiesAutoMLModel.runtime_infoAutoMLModel.schema_inputAutoMLModel.schema_outputAutoMLModel.serializeAutoMLModel.versionAutoMLModel.delete_deployment()AutoMLModel.deploy()AutoMLModel.from_model_artifact()AutoMLModel.from_model_catalog()AutoMLModel.introspect()AutoMLModel.predict()AutoMLModel.prepare()AutoMLModel.reload()AutoMLModel.save()AutoMLModel.summary_status()AutoMLModel.verify()AutoMLModel.serialize_model()
- ads.model.framework.lightgbm_model module
LightGBMModelLightGBMModel.algorithmLightGBMModel.artifact_dirLightGBMModel.authLightGBMModel.ds_clientLightGBMModel.estimatorLightGBMModel.frameworkLightGBMModel.hyperparameterLightGBMModel.metadata_customLightGBMModel.metadata_provenanceLightGBMModel.metadata_taxonomyLightGBMModel.model_artifactLightGBMModel.model_deploymentLightGBMModel.model_file_nameLightGBMModel.model_idLightGBMModel.propertiesLightGBMModel.runtime_infoLightGBMModel.schema_inputLightGBMModel.schema_outputLightGBMModel.serializeLightGBMModel.versionLightGBMModel.delete_deployment()LightGBMModel.deploy()LightGBMModel.from_model_artifact()LightGBMModel.from_model_catalog()LightGBMModel.introspect()LightGBMModel.predict()LightGBMModel.prepare()LightGBMModel.reload()LightGBMModel.save()LightGBMModel.summary_status()LightGBMModel.verify()LightGBMModel.generate_initial_types()LightGBMModel.serialize_model()LightGBMModel.to_onnx()
- ads.model.framework.pytorch_model module
PyTorchModelPyTorchModel.algorithmPyTorchModel.artifact_dirPyTorchModel.authPyTorchModel.ds_clientPyTorchModel.estimatorPyTorchModel.frameworkPyTorchModel.hyperparameterPyTorchModel.metadata_customPyTorchModel.metadata_provenancePyTorchModel.metadata_taxonomyPyTorchModel.model_artifactPyTorchModel.model_deploymentPyTorchModel.model_file_namePyTorchModel.model_idPyTorchModel.propertiesPyTorchModel.runtime_infoPyTorchModel.schema_inputPyTorchModel.schema_outputPyTorchModel.serializePyTorchModel.versionPyTorchModel.delete_deployment()PyTorchModel.deploy()PyTorchModel.from_model_artifact()PyTorchModel.from_model_catalog()PyTorchModel.introspect()PyTorchModel.predict()PyTorchModel.prepare()PyTorchModel.reload()PyTorchModel.save()PyTorchModel.summary_status()PyTorchModel.verify()PyTorchModel.get_data_serializer()PyTorchModel.serialize_model()PyTorchModel.to_onnx()
- ads.model.framework.sklearn_model module
SklearnModelSklearnModel.algorithmSklearnModel.artifact_dirSklearnModel.authSklearnModel.ds_clientSklearnModel.estimatorSklearnModel.frameworkSklearnModel.hyperparameterSklearnModel.metadata_customSklearnModel.metadata_provenanceSklearnModel.metadata_taxonomySklearnModel.model_artifactSklearnModel.model_deploymentSklearnModel.model_file_nameSklearnModel.model_idSklearnModel.propertiesSklearnModel.runtime_infoSklearnModel.schema_inputSklearnModel.schema_outputSklearnModel.serializeSklearnModel.versionSklearnModel.delete_deployment()SklearnModel.deploy()SklearnModel.from_model_artifact()SklearnModel.from_model_catalog()SklearnModel.introspect()SklearnModel.predict()SklearnModel.prepare()SklearnModel.reload()SklearnModel.save()SklearnModel.summary_status()SklearnModel.verify()SklearnModel.generate_initial_types()SklearnModel.is_either_numerical_or_string_dataframe()SklearnModel.serialize_model()SklearnModel.to_onnx()
- ads.model.framework.tensorflow_model module
TensorFlowModelTensorFlowModel.algorithmTensorFlowModel.artifact_dirTensorFlowModel.authTensorFlowModel.ds_clientTensorFlowModel.estimatorTensorFlowModel.frameworkTensorFlowModel.hyperparameterTensorFlowModel.metadata_customTensorFlowModel.metadata_provenanceTensorFlowModel.metadata_taxonomyTensorFlowModel.model_artifactTensorFlowModel.model_deploymentTensorFlowModel.model_file_nameTensorFlowModel.model_idTensorFlowModel.propertiesTensorFlowModel.runtime_infoTensorFlowModel.schema_inputTensorFlowModel.schema_outputTensorFlowModel.serializeTensorFlowModel.versionTensorFlowModel.delete_deployment()TensorFlowModel.deploy()TensorFlowModel.from_model_artifact()TensorFlowModel.from_model_catalog()TensorFlowModel.introspect()TensorFlowModel.predict()TensorFlowModel.prepare()TensorFlowModel.reload()TensorFlowModel.save()TensorFlowModel.summary_status()TensorFlowModel.verify()TensorFlowModel.get_data_serializer()TensorFlowModel.serialize_model()TensorFlowModel.to_onnx()
- ads.model.framework.xgboost_model module
XGBoostModelXGBoostModel.algorithmXGBoostModel.artifact_dirXGBoostModel.authXGBoostModel.ds_clientXGBoostModel.estimatorXGBoostModel.frameworkXGBoostModel.hyperparameterXGBoostModel.metadata_customXGBoostModel.metadata_provenanceXGBoostModel.metadata_taxonomyXGBoostModel.model_artifactXGBoostModel.model_deploymentXGBoostModel.model_file_nameXGBoostModel.model_idXGBoostModel.propertiesXGBoostModel.runtime_infoXGBoostModel.schema_inputXGBoostModel.schema_outputXGBoostModel.serializeXGBoostModel.versionXGBoostModel.delete_deployment()XGBoostModel.deploy()XGBoostModel.from_model_artifact()XGBoostModel.from_model_catalog()XGBoostModel.introspect()XGBoostModel.predict()XGBoostModel.prepare()XGBoostModel.reload()XGBoostModel.save()XGBoostModel.summary_status()XGBoostModel.verify()XGBoostModel.generate_initial_types()XGBoostModel.serialize_model()XGBoostModel.to_onnx()
- Module contents
- ads.model.runtime package
- Submodules
- ads.model.runtime.env_info module
- ads.model.runtime.model_deployment_details module
- ads.model.runtime.model_provenance_details module
ModelProvenanceDetailsModelProvenanceDetails.project_ocidModelProvenanceDetails.tenancy_ocidModelProvenanceDetails.training_codeModelProvenanceDetails.training_compartment_ocidModelProvenanceDetails.training_conda_envModelProvenanceDetails.training_regionModelProvenanceDetails.training_resource_ocidModelProvenanceDetails.user_ocidModelProvenanceDetails.vm_image_internal_id
TrainingCode
- ads.model.runtime.runtime_info module
- ads.model.runtime.utils module
- Module contents
- ads.oracledb package
- ads.secrets package
- Submodules
- ads.secrets.secrets module
- ads.secrets.adb module
- ads.secrets.mysqldb module
- ads.secrets.oracledb 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.auth_token module
- Module contents
- ads.text_dataset package
- ads.vault package
Submodules
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.