ads package
Subpackages
- ads.automl package
- Submodules
- ads.automl.driver module
- ads.automl.provider module
AutoMLFeatureSelection
AutoMLPreprocessingTransformer
AutoMLProvider
BaselineAutoMLProvider
BaselineModel
OracleAutoMLProvider
OracleAutoMLProvider.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
Model
ModelArtifactSizeError
ModelCatalog
ModelCatalog.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()
ModelSummaryList
ModelWithActiveDeploymentError
- 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
ADSModel
ADSModel.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
OptionalDependency
OptionalDependency.BDS
OptionalDependency.BOOSTED
OptionalDependency.DATA
OptionalDependency.GEO
OptionalDependency.LABS
OptionalDependency.MYSQL
OptionalDependency.NOTEBOOK
OptionalDependency.ONNX
OptionalDependency.OPCTL
OptionalDependency.OPTUNA
OptionalDependency.PYTORCH
OptionalDependency.SPARK
OptionalDependency.TENSORFLOW
OptionalDependency.TEXT
OptionalDependency.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
FileOverwriteError
JsonConverter
batch_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_types
numeric_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
BoundingBoxItem
BoundingBoxItem.labels
BoundingBoxItem.top_left
BoundingBoxItem.bottom_left
BoundingBoxItem.bottom_right
BoundingBoxItem.top_right
BoundingBoxItem.bottom_left
BoundingBoxItem.bottom_right
BoundingBoxItem.from_yolo()
BoundingBoxItem.labels
BoundingBoxItem.to_yolo()
BoundingBoxItem.top_left
BoundingBoxItem.top_right
BoundingBoxItems
- ads.data_labeling.constants module
- ads.data_labeling.data_labeling_service module
- ads.data_labeling.metadata module
Metadata
Metadata.source_path
Metadata.records_path
Metadata.labels
Metadata.dataset_name
Metadata.compartment_id
Metadata.dataset_id
Metadata.annotation_type
Metadata.dataset_type
Metadata.annotation_type
Metadata.compartment_id
Metadata.dataset_id
Metadata.dataset_name
Metadata.dataset_type
Metadata.from_dls_dataset()
Metadata.labels
Metadata.records_path
Metadata.source_path
Metadata.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
ADSDataset
ADSDataset.assign_column()
ADSDataset.astype()
ADSDataset.call()
ADSDataset.compute()
ADSDataset.corr()
ADSDataset.ddf
ADSDataset.df_read_functions
ADSDataset.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
ADSDatasetWithTarget
ADSDatasetWithTarget.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
CustomFormatReaders
CustomFormatReaders.DEFAULT_SQL_ARRAYSIZE
CustomFormatReaders.DEFAULT_SQL_CHUNKSIZE
CustomFormatReaders.DEFAULT_SQL_CTU
CustomFormatReaders.DEFAULT_SQL_MIL
CustomFormatReaders.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()
DatasetFactory
get_format_reader()
load_dataset()
- ads.dataset.feature_engineering_transformer module
- ads.dataset.feature_selection module
- ads.dataset.forecasting_dataset module
- ads.dataset.helper module
DatasetDefaults
DatasetLoadException
ElaboratedPath
calculate_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
EvaluationPlot
EvaluationPlot.baseline
EvaluationPlot.baseline_kwargs
EvaluationPlot.color_wheel
EvaluationPlot.font_sz
EvaluationPlot.perfect
EvaluationPlot.perfect_kwargs
EvaluationPlot.prob_type
EvaluationPlot.get_legend_labels()
EvaluationPlot.plot()
EvaluationPlot.baseline
EvaluationPlot.baseline_kwargs
EvaluationPlot.color_wheel
EvaluationPlot.double_overlay_plots
EvaluationPlot.font_sz
EvaluationPlot.get_legend_labels()
EvaluationPlot.perfect
EvaluationPlot.perfect_kwargs
EvaluationPlot.plot()
EvaluationPlot.prob_type
EvaluationPlot.single_overlay_plots
- ads.evaluations.evaluator module
ADSEvaluator
ADSEvaluator.evaluations
ADSEvaluator.is_classifier
ADSEvaluator.legend_labels
ADSEvaluator.metrics_to_show
ADSEvaluator.models
ADSEvaluator.positive_class
ADSEvaluator.show_full_name
ADSEvaluator.test_data
ADSEvaluator.training_data
ADSEvaluator.Positive_Class_names
ADSEvaluator.add_metrics()
ADSEvaluator.del_metrics()
ADSEvaluator.add_models()
ADSEvaluator.del_models()
ADSEvaluator.show_in_notebook()
ADSEvaluator.calculate_cost()
ADSEvaluator.EvaluationMetrics
ADSEvaluator.EvaluationMetrics.ev_test
ADSEvaluator.EvaluationMetrics.ev_train
ADSEvaluator.EvaluationMetrics.use_training
ADSEvaluator.EvaluationMetrics.less_is_more
ADSEvaluator.EvaluationMetrics.show_in_notebook()
ADSEvaluator.EvaluationMetrics.DEFAULT_LABELS_MAP
ADSEvaluator.EvaluationMetrics.precision
ADSEvaluator.EvaluationMetrics.show_in_notebook()
ADSEvaluator.Positive_Class_Names
ADSEvaluator.add_metrics()
ADSEvaluator.add_models()
ADSEvaluator.calculate_cost()
ADSEvaluator.del_metrics()
ADSEvaluator.del_models()
ADSEvaluator.metrics
ADSEvaluator.raw_metrics
ADSEvaluator.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
FeatureTypeManager
FeatureTypeManager.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
ADSDataFrameAccessor
ADSDataFrameAccessor.columns
ADSDataFrameAccessor.tags
ADSDataFrameAccessor.default_type
ADSDataFrameAccessor.feature_type
ADSDataFrameAccessor.feature_type_description
ADSDataFrameAccessor.sync()
ADSDataFrameAccessor.feature_select()
ADSDataFrameAccessor.help()
ADSDataFrameAccessor.default_type
ADSDataFrameAccessor.feature_select()
ADSDataFrameAccessor.feature_type
ADSDataFrameAccessor.feature_type_description
ADSDataFrameAccessor.info()
ADSDataFrameAccessor.model_schema()
ADSDataFrameAccessor.sync()
ADSDataFrameAccessor.tags
- ads.feature_engineering.accessor.series_accessor module
ADSSeriesAccessor
ADSSeriesAccessor.name
ADSSeriesAccessor.tags
ADSSeriesAccessor.help()
ADSSeriesAccessor.sync()
ADSSeriesAccessor.default_type
ADSSeriesAccessor.feature_type
ADSSeriesAccessor.feature_type_description
ADSSeriesAccessor.default_type
ADSSeriesAccessor.feature_type
ADSSeriesAccessor.feature_type_description
ADSSeriesAccessor.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
CommonRegexMixin
CommonRegexMixin.address
CommonRegexMixin.credit_card
CommonRegexMixin.date
CommonRegexMixin.email
CommonRegexMixin.ip
CommonRegexMixin.link
CommonRegexMixin.phone_number_US
CommonRegexMixin.price
CommonRegexMixin.redact()
CommonRegexMixin.redact_map
CommonRegexMixin.ssn
CommonRegexMixin.time
CommonRegexMixin.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
ADSTuner
ADSTuner.best_index
ADSTuner.best_params
ADSTuner.best_score
ADSTuner.best_scores()
ADSTuner.get_status()
ADSTuner.halt()
ADSTuner.is_completed()
ADSTuner.is_halted()
ADSTuner.is_running()
ADSTuner.is_terminated()
ADSTuner.n_trials
ADSTuner.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_remaining
ADSTuner.scoring_name
ADSTuner.search_space()
ADSTuner.sklearn_steps
ADSTuner.status
ADSTuner.terminate()
ADSTuner.time_elapsed
ADSTuner.time_remaining
ADSTuner.time_since_resume
ADSTuner.trial_count
ADSTuner.trials
ADSTuner.trials_export()
ADSTuner.trials_import()
ADSTuner.trials_remaining
ADSTuner.tune()
ADSTuner.wait()
DuplicatedStudyError
ExitCriterionError
InvalidStateTransition
NoRestartError
State
- ads.hpo.stopping_criterion
- Module contents
- ads.jobs package
- Submodules
- ads.jobs.ads_job module
Job
Job.create()
Job.dataflow_job()
Job.datascience_job()
Job.delete()
Job.download()
Job.from_dataflow_job()
Job.from_datascience_job()
Job.from_dict()
Job.id
Job.infrastructure
Job.kind
Job.name
Job.run()
Job.run_list()
Job.runtime
Job.status()
Job.to_dict()
Job.with_infrastructure()
Job.with_name()
Job.with_runtime()
- ads.jobs.builders.runtimes.python_runtime module
CondaRuntime
CondaRuntime.CONST_CONDA
CondaRuntime.CONST_CONDA_REGION
CondaRuntime.CONST_CONDA_SLUG
CondaRuntime.CONST_CONDA_TYPE
CondaRuntime.CONST_CONDA_TYPE_CUSTOM
CondaRuntime.CONST_CONDA_TYPE_SERVICE
CondaRuntime.CONST_CONDA_URI
CondaRuntime.attribute_map
CondaRuntime.conda
CondaRuntime.with_custom_conda()
CondaRuntime.with_service_conda()
DataFlowNotebookRuntime
DataFlowRuntime
DataFlowRuntime.CONST_ARCHIVE_BUCKET
DataFlowRuntime.CONST_ARCHIVE_URI
DataFlowRuntime.CONST_CONDA_AUTH_TYPE
DataFlowRuntime.CONST_CONFIGURATION
DataFlowRuntime.CONST_SCRIPT_BUCKET
DataFlowRuntime.CONST_SCRIPT_PATH
DataFlowRuntime.archive_bucket
DataFlowRuntime.archive_uri
DataFlowRuntime.attribute_map
DataFlowRuntime.configuration
DataFlowRuntime.convert()
DataFlowRuntime.script_bucket
DataFlowRuntime.script_uri
DataFlowRuntime.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()
GitPythonRuntime
GitPythonRuntime.CONST_BRANCH
GitPythonRuntime.CONST_COMMIT
GitPythonRuntime.CONST_GIT_SSH_SECRET_ID
GitPythonRuntime.CONST_GIT_URL
GitPythonRuntime.CONST_SKIP_METADATA
GitPythonRuntime.attribute_map
GitPythonRuntime.branch
GitPythonRuntime.commit
GitPythonRuntime.skip_metadata_update
GitPythonRuntime.ssh_secret_ocid
GitPythonRuntime.url
GitPythonRuntime.with_argument()
GitPythonRuntime.with_source()
NotebookRuntime
NotebookRuntime.CONST_EXCLUDE_TAG
NotebookRuntime.CONST_NOTEBOOK_ENCODING
NotebookRuntime.CONST_NOTEBOOK_PATH
NotebookRuntime.CONST_OUTPUT_URI
NotebookRuntime.attribute_map
NotebookRuntime.exclude_tag
NotebookRuntime.notebook_encoding
NotebookRuntime.notebook_uri
NotebookRuntime.output_uri
NotebookRuntime.with_exclude_tag()
NotebookRuntime.with_notebook()
NotebookRuntime.with_output()
PythonRuntime
ScriptRuntime
- ads.jobs.builders.infrastructure.dataflow module
DataFlow
DataFlow.CONST_BUCKET_URI
DataFlow.CONST_COMPARTMENT_ID
DataFlow.CONST_CONFIG
DataFlow.CONST_DRIVER_SHAPE
DataFlow.CONST_DRIVER_SHAPE_CONFIG
DataFlow.CONST_EXECUTE
DataFlow.CONST_EXECUTOR_SHAPE
DataFlow.CONST_EXECUTOR_SHAPE_CONFIG
DataFlow.CONST_ID
DataFlow.CONST_LANGUAGE
DataFlow.CONST_MEMORY_IN_GBS
DataFlow.CONST_METASTORE_ID
DataFlow.CONST_NUM_EXECUTORS
DataFlow.CONST_OCPUS
DataFlow.CONST_SPARK_VERSION
DataFlow.CONST_WAREHOUSE_BUCKET_URI
DataFlow.attribute_map
DataFlow.create()
DataFlow.delete()
DataFlow.from_dict()
DataFlow.from_id()
DataFlow.job_id
DataFlow.list_jobs()
DataFlow.name
DataFlow.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()
DataFlowApp
DataFlowLogs
DataFlowRun
- ads.jobs.builders.infrastructure.dsc_job module
DSCJob
DSCJobRun
DataScienceJob
DataScienceJob.CONST_BLOCK_STORAGE
DataScienceJob.CONST_COMPARTMENT_ID
DataScienceJob.CONST_DISPLAY_NAME
DataScienceJob.CONST_JOB_INFRA
DataScienceJob.CONST_JOB_TYPE
DataScienceJob.CONST_LOG_GROUP_ID
DataScienceJob.CONST_LOG_ID
DataScienceJob.CONST_MEMORY_IN_GBS
DataScienceJob.CONST_OCPUS
DataScienceJob.CONST_PROJECT_ID
DataScienceJob.CONST_SHAPE_CONFIG_DETAILS
DataScienceJob.CONST_SHAPE_NAME
DataScienceJob.CONST_SUBNET_ID
DataScienceJob.attribute_map
DataScienceJob.block_storage_size
DataScienceJob.compartment_id
DataScienceJob.create()
DataScienceJob.delete()
DataScienceJob.from_dsc_job()
DataScienceJob.from_id()
DataScienceJob.instance_shapes()
DataScienceJob.job_id
DataScienceJob.job_infrastructure_type
DataScienceJob.job_type
DataScienceJob.list_jobs()
DataScienceJob.log_group_id
DataScienceJob.log_id
DataScienceJob.name
DataScienceJob.payload_attribute_map
DataScienceJob.project_id
DataScienceJob.run()
DataScienceJob.run_list()
DataScienceJob.shape_config_details
DataScienceJob.shape_config_details_attribute_map
DataScienceJob.shape_name
DataScienceJob.snake_to_camel_map
DataScienceJob.standardize_spec()
DataScienceJob.status
DataScienceJob.subnet_id
DataScienceJob.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()
DataScienceJobRun
DataScienceJobRun.TERMINAL_STATES
DataScienceJobRun.cancel()
DataScienceJobRun.create()
DataScienceJobRun.download()
DataScienceJobRun.job
DataScienceJobRun.log_group_id
DataScienceJobRun.log_id
DataScienceJobRun.logging
DataScienceJobRun.logs()
DataScienceJobRun.status
DataScienceJobRun.to_yaml()
DataScienceJobRun.watch()
- Module contents
- ads.model.framework other package
- Submodules
- ads.model.artifact module
- ads.model.generic_model module
DataScienceModelType
FrameworkSpecificModel
GenericModel
GenericModel.algorithm
GenericModel.artifact_dir
GenericModel.auth
GenericModel.estimator
GenericModel.framework
GenericModel.hyperparameter
GenericModel.metadata_custom
GenericModel.metadata_provenance
GenericModel.metadata_taxonomy
GenericModel.model_artifact
GenericModel.model_deployment
GenericModel.model_file_name
GenericModel.model_id
GenericModel.properties
GenericModel.runtime_info
GenericModel.schema_input
GenericModel.schema_output
GenericModel.serialize
GenericModel.version
GenericModel.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.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_custom
GenericModel.metadata_provenance
GenericModel.metadata_taxonomy
GenericModel.model_deployment_id
GenericModel.model_id
GenericModel.predict()
GenericModel.prepare()
GenericModel.prepare_save_deploy()
GenericModel.reload()
GenericModel.reload_runtime_info()
GenericModel.save()
GenericModel.schema_input
GenericModel.schema_output
GenericModel.serialize_model()
GenericModel.summary_status()
GenericModel.update()
GenericModel.update_deployment()
GenericModel.upload_artifact()
GenericModel.verify()
ModelState
NotActiveDeploymentError
RuntimeInfoInconsistencyError
SerializeInputNotImplementedError
SerializeModelNotImplementedError
SummaryStatus
- ads.model.model_properties module
ModelProperties
ModelProperties.bucket_uri
ModelProperties.compartment_id
ModelProperties.deployment_access_log_id
ModelProperties.deployment_bandwidth_mbps
ModelProperties.deployment_instance_count
ModelProperties.deployment_instance_shape
ModelProperties.deployment_log_group_id
ModelProperties.deployment_memory_in_gbs
ModelProperties.deployment_ocpus
ModelProperties.deployment_predict_log_id
ModelProperties.inference_conda_env
ModelProperties.inference_python_version
ModelProperties.overwrite_existing_artifact
ModelProperties.project_id
ModelProperties.remove_existing_artifact
ModelProperties.training_conda_env
ModelProperties.training_id
ModelProperties.training_python_version
ModelProperties.training_resource_id
ModelProperties.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
ModelInfoExtractor
ModelInfoExtractor.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
TensorflowExtractor
TensorflowExtractor.model
TensorflowExtractor.estimator
TensorflowExtractor.framework()
TensorflowExtractor.algorithm()
TensorflowExtractor.version()
TensorflowExtractor.hyperparameter()
TensorflowExtractor.algorithm
TensorflowExtractor.framework
TensorflowExtractor.hyperparameter
TensorflowExtractor.version
- ads.model.extractor.pytorch_extractor module
- Module contents
- ads.model.deployment package
- Submodules
- ads.model.deployment.model_deployer module
ModelDeployer
ModelDeployer.config
ModelDeployer.ds_client
ModelDeployer.ds_composite_client
ModelDeployer.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
LogNotConfiguredError
ModelDeployment
ModelDeployment.config
ModelDeployment.properties
ModelDeployment.workflow_state_progress
ModelDeployment.workflow_steps
ModelDeployment.url
ModelDeployment.ds_client
ModelDeployment.ds_composite_client
ModelDeployment.workflow_req_id
ModelDeployment.model_deployment_id
ModelDeployment.state
ModelDeployment.deploy()
ModelDeployment.delete()
ModelDeployment.update()
ModelDeployment.list_workflow_logs()
ModelDeployment.access_log
ModelDeployment.delete()
ModelDeployment.deploy()
ModelDeployment.list_workflow_logs()
ModelDeployment.logs()
ModelDeployment.predict()
ModelDeployment.predict_log
ModelDeployment.show_logs()
ModelDeployment.state
ModelDeployment.status
ModelDeployment.update()
ModelDeploymentLogType
- ads.model.deployment.model_deployment_properties module
ModelDeploymentProperties
ModelDeploymentProperties.swagger_types
ModelDeploymentProperties.model_id
ModelDeploymentProperties.model_uri
ModelDeploymentProperties.with_prop()
ModelDeploymentProperties.with_instance_configuration()
ModelDeploymentProperties.with_access_log()
ModelDeploymentProperties.with_predict_log()
ModelDeploymentProperties.build()
ModelDeploymentProperties.build()
ModelDeploymentProperties.sub_properties
ModelDeploymentProperties.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
AutoMLModel
AutoMLModel.algorithm
AutoMLModel.artifact_dir
AutoMLModel.auth
AutoMLModel.ds_client
AutoMLModel.estimator
AutoMLModel.framework
AutoMLModel.hyperparameter
AutoMLModel.metadata_custom
AutoMLModel.metadata_provenance
AutoMLModel.metadata_taxonomy
AutoMLModel.model_artifact
AutoMLModel.model_deployment
AutoMLModel.model_file_name
AutoMLModel.model_id
AutoMLModel.properties
AutoMLModel.runtime_info
AutoMLModel.schema_input
AutoMLModel.schema_output
AutoMLModel.serialize
AutoMLModel.version
AutoMLModel.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
LightGBMModel
LightGBMModel.algorithm
LightGBMModel.artifact_dir
LightGBMModel.auth
LightGBMModel.ds_client
LightGBMModel.estimator
LightGBMModel.framework
LightGBMModel.hyperparameter
LightGBMModel.metadata_custom
LightGBMModel.metadata_provenance
LightGBMModel.metadata_taxonomy
LightGBMModel.model_artifact
LightGBMModel.model_deployment
LightGBMModel.model_file_name
LightGBMModel.model_id
LightGBMModel.properties
LightGBMModel.runtime_info
LightGBMModel.schema_input
LightGBMModel.schema_output
LightGBMModel.serialize
LightGBMModel.version
LightGBMModel.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
PyTorchModel
PyTorchModel.algorithm
PyTorchModel.artifact_dir
PyTorchModel.auth
PyTorchModel.ds_client
PyTorchModel.estimator
PyTorchModel.framework
PyTorchModel.hyperparameter
PyTorchModel.metadata_custom
PyTorchModel.metadata_provenance
PyTorchModel.metadata_taxonomy
PyTorchModel.model_artifact
PyTorchModel.model_deployment
PyTorchModel.model_file_name
PyTorchModel.model_id
PyTorchModel.properties
PyTorchModel.runtime_info
PyTorchModel.schema_input
PyTorchModel.schema_output
PyTorchModel.serialize
PyTorchModel.version
PyTorchModel.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
SklearnModel
SklearnModel.algorithm
SklearnModel.artifact_dir
SklearnModel.auth
SklearnModel.ds_client
SklearnModel.estimator
SklearnModel.framework
SklearnModel.hyperparameter
SklearnModel.metadata_custom
SklearnModel.metadata_provenance
SklearnModel.metadata_taxonomy
SklearnModel.model_artifact
SklearnModel.model_deployment
SklearnModel.model_file_name
SklearnModel.model_id
SklearnModel.properties
SklearnModel.runtime_info
SklearnModel.schema_input
SklearnModel.schema_output
SklearnModel.serialize
SklearnModel.version
SklearnModel.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
TensorFlowModel
TensorFlowModel.algorithm
TensorFlowModel.artifact_dir
TensorFlowModel.auth
TensorFlowModel.ds_client
TensorFlowModel.estimator
TensorFlowModel.framework
TensorFlowModel.hyperparameter
TensorFlowModel.metadata_custom
TensorFlowModel.metadata_provenance
TensorFlowModel.metadata_taxonomy
TensorFlowModel.model_artifact
TensorFlowModel.model_deployment
TensorFlowModel.model_file_name
TensorFlowModel.model_id
TensorFlowModel.properties
TensorFlowModel.runtime_info
TensorFlowModel.schema_input
TensorFlowModel.schema_output
TensorFlowModel.serialize
TensorFlowModel.version
TensorFlowModel.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
XGBoostModel
XGBoostModel.algorithm
XGBoostModel.artifact_dir
XGBoostModel.auth
XGBoostModel.ds_client
XGBoostModel.estimator
XGBoostModel.framework
XGBoostModel.hyperparameter
XGBoostModel.metadata_custom
XGBoostModel.metadata_provenance
XGBoostModel.metadata_taxonomy
XGBoostModel.model_artifact
XGBoostModel.model_deployment
XGBoostModel.model_file_name
XGBoostModel.model_id
XGBoostModel.properties
XGBoostModel.runtime_info
XGBoostModel.schema_input
XGBoostModel.schema_output
XGBoostModel.serialize
XGBoostModel.version
XGBoostModel.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
ModelProvenanceDetails
ModelProvenanceDetails.project_ocid
ModelProvenanceDetails.tenancy_ocid
ModelProvenanceDetails.training_code
ModelProvenanceDetails.training_compartment_ocid
ModelProvenanceDetails.training_conda_env
ModelProvenanceDetails.training_region
ModelProvenanceDetails.training_resource_ocid
ModelProvenanceDetails.user_ocid
ModelProvenanceDetails.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
BDSSecret
BDSSecret.principal
BDSSecret.hdfs_host
BDSSecret.hive_host
BDSSecret.hdfs_port
BDSSecret.hive_port
BDSSecret.kerb5_path
BDSSecret.kerb5_content
BDSSecret.keytab_path
BDSSecret.keytab_content
BDSSecret.secret_id
BDSSecret.hdfs_host
BDSSecret.hdfs_port
BDSSecret.hive_host
BDSSecret.hive_port
BDSSecret.kerb5_content
BDSSecret.kerb5_path
BDSSecret.keytab_content
BDSSecret.keytab_path
BDSSecret.principal
BDSSecret.secret_id
BDSSecretKeeper
BDSSecretKeeper.principal
BDSSecretKeeper.hdfs_host
BDSSecretKeeper.hive_host
BDSSecretKeeper.hdfs_port
BDSSecretKeeper.hive_port
BDSSecretKeeper.kerb5_path
BDSSecretKeeper.kerb5_content
BDSSecretKeeper.keytab_path
BDSSecretKeeper.keytab_content
BDSSecretKeeper.secret_id
BDSSecretKeeper.kwargs
BDSSecretKeeper.vault_id
BDSSecretKeeper.key_id
BDSSecretKeeper.compartment_id
BDSSecretKeeper.auth
BDSSecretKeeper.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.