ads package
Subpackages
- ads.bds package
- 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
- Subpackages
- Submodules
- ads.common.analyzer module
- ads.common.auth module
- ads.common.base_properties module
BaseProperties
BaseProperties.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
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_artifact module
ConflictStrategy
InvalidDataType
ModelArtifact
ModelArtifact.artifact_dir
ModelArtifact.conflict_strategy
ModelArtifact.install_libs
ModelArtifact.reload
ModelArtifact.create
ModelArtifact.progress
ModelArtifact.model_file_name
ModelArtifact.inference_conda_env
ModelArtifact.data_science_env
ModelArtifact.ignore_deployment_error
ModelArtifact.inference_python_version
ModelArtifact.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_TYPE
VersionConflictWarning
execute()
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
InvalidObjectStoragePath
ObjectStorageDetails
ObjectStorageDetails.bucket
ObjectStorageDetails.namespace
ObjectStorageDetails.filepath
ObjectStorageDetails.auth
ObjectStorageDetails.auth
ObjectStorageDetails.bucket
ObjectStorageDetails.fetch_metadata_of_object()
ObjectStorageDetails.filepath
ObjectStorageDetails.from_path()
ObjectStorageDetails.is_valid_uri()
ObjectStorageDetails.namespace
ObjectStorageDetails.path
ObjectStorageDetails.to_tuple()
- ads.common.oci_client module
- ads.common.oci_datascience module
- ads.common.oci_logging module
- ads.common.oci_mixin module
MergeStrategy
OCIClientMixin
OCIModelMixin
OCIModelMixin.CONS_COMPARTMENT_ID
OCIModelMixin.OCI_MODEL_PATTERN
OCIModelMixin.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.name
OCIModelMixin.status
OCIModelMixin.sync()
OCIModelMixin.to_dict()
OCIModelMixin.to_oci_model()
OCIModelMixin.to_yaml()
OCIModelMixin.update_from_oci_model()
OCIModelNotExists
OCIModelWithNameMixin
OCISerializableMixin
OCIWorkRequestMixin
- ads.common.oci_resource module
- ads.common.serializer module
DataClassSerializable
Serializable
Serializable.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
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()
- 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
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
- 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
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.dbmixin package
- ads.environment package
- 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.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.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
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.schema module
Attribute
BaseSchemaLoader
DataSizeTooWide
Domain
Expression
JsonSchemaLoader
Schema
Schema.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.keys
Schema.to_dict()
Schema.to_json()
Schema.to_json_file()
Schema.to_yaml()
Schema.to_yaml_file()
Schema.validate_schema()
Schema.validate_size()
SchemaFactory
SchemaSizeTooLarge
YamlSchemaLoader
- ads.feature_engineering.utils module
- Module contents
- Subpackages
- ads.hpo package
- Subpackages
- Submodules
- ads.hpo.ads_search_space module
DecisionTreeClassifierSearchSpace
DecisionTreeRegressorSearchSpace
ElasticNetSearchSpace
ExtraTreesClassifierSearchSpace
ExtraTreesRegressorSearchSpace
GradientBoostingClassifierSearchSpace
GradientBoostingRegressorSearchSpace
LGBMClassifierSearchSpace
LGBMRegressorSearchSpace
LassoSearchSpace
LinearSVCSearchSpace
LinearSVRSearchSpace
LogisticRegressionSearchSpace
ModelSearchSpace
RandomForestClassifierSearchSpace
RandomForestRegressorSearchSpace
RidgeClassifierSearchSpace
RidgeSearchSpace
SGDClassifierSearchSpace
SGDRegressorSearchSpace
SVCSearchSpace
SVRSearchSpace
XGBClassifierSearchSpace
XGBRegressorSearchSpace
get_model2searchspace()
- ads.hpo.distributions module
- ads.hpo.objective 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
- 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
BaseProperties
BaseProperties.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()
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.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_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.restart_deployment()
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_introspect module
- ads.model.model_metadata module
Framework
Framework.BERT
Framework.CUML
Framework.EMCEE
Framework.ENSEMBLE
Framework.FLAIR
Framework.GENSIM
Framework.H20
Framework.KERAS
Framework.LIGHT_GBM
Framework.MXNET
Framework.NLTK
Framework.ORACLE_AUTOML
Framework.OTHER
Framework.PROPHET
Framework.PYMC3
Framework.PYOD
Framework.PYSTAN
Framework.PYTORCH
Framework.SCIKIT_LEARN
Framework.SKTIME
Framework.SPACY
Framework.SPARK
Framework.STATSMODELS
Framework.TENSORFLOW
Framework.TRANSFORMERS
Framework.WORD2VEC
Framework.XGBOOST
MetadataCustomCategory
MetadataCustomKeys
MetadataCustomKeys.CLIENT_LIBRARY
MetadataCustomKeys.CONDA_ENVIRONMENT
MetadataCustomKeys.CONDA_ENVIRONMENT_PATH
MetadataCustomKeys.ENVIRONMENT_TYPE
MetadataCustomKeys.MODEL_ARTIFACTS
MetadataCustomKeys.MODEL_FILE_NAME
MetadataCustomKeys.MODEL_SERIALIZATION_FORMAT
MetadataCustomKeys.SLUG_NAME
MetadataCustomKeys.TRAINING_DATASET
MetadataCustomKeys.TRAINING_DATASET_NUMBER_OF_COLS
MetadataCustomKeys.TRAINING_DATASET_NUMBER_OF_ROWS
MetadataCustomKeys.TRAINING_DATASET_SIZE
MetadataCustomKeys.VALIDATION_DATASET
MetadataCustomKeys.VALIDATION_DATASET_NUMBER_OF_COLS
MetadataCustomKeys.VALIDATION_DATASET_NUMBER_OF_ROWS
MetadataCustomKeys.VALIDATION_DATASET_SIZE
MetadataCustomPrintColumns
MetadataDescriptionTooLong
MetadataSizeTooLarge
MetadataTaxonomyKeys
MetadataTaxonomyPrintColumns
MetadataValueTooLong
ModelCustomMetadata
ModelCustomMetadata.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()
ModelCustomMetadataItem
ModelCustomMetadataItem.key
ModelCustomMetadataItem.value
ModelCustomMetadataItem.description
ModelCustomMetadataItem.category
ModelCustomMetadataItem.reset()
ModelCustomMetadataItem.to_dict()
ModelCustomMetadataItem.from_dict()
ModelCustomMetadataItem.to_yaml()
ModelCustomMetadataItem.size()
ModelCustomMetadataItem.update()
ModelCustomMetadataItem.to_json()
ModelCustomMetadataItem.to_json_file()
ModelCustomMetadataItem.validate()
ModelCustomMetadataItem.category
ModelCustomMetadataItem.description
ModelCustomMetadataItem.reset()
ModelCustomMetadataItem.update()
ModelCustomMetadataItem.validate()
ModelMetadata
ModelMetadata.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.keys
ModelMetadata.reset()
ModelMetadata.size()
ModelMetadata.to_dataframe()
ModelMetadata.to_dict()
ModelMetadata.to_json()
ModelMetadata.to_json_file()
ModelMetadata.to_yaml()
ModelMetadata.validate()
ModelMetadata.validate_size()
ModelMetadataItem
ModelMetadataItem.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()
ModelProvenanceMetadata
ModelProvenanceMetadata.artifact_dir
ModelProvenanceMetadata.assert_path_not_dirty()
ModelProvenanceMetadata.fetch_training_code_details()
ModelProvenanceMetadata.from_dict()
ModelProvenanceMetadata.git_branch
ModelProvenanceMetadata.git_commit
ModelProvenanceMetadata.repo
ModelProvenanceMetadata.repository_url
ModelProvenanceMetadata.to_dict()
ModelProvenanceMetadata.training_id
ModelProvenanceMetadata.training_script_path
ModelTaxonomyMetadata
ModelTaxonomyMetadata.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()
ModelTaxonomyMetadataItem
ModelTaxonomyMetadataItem.key
ModelTaxonomyMetadataItem.value
ModelTaxonomyMetadataItem.reset()
ModelTaxonomyMetadataItem.to_dict()
ModelTaxonomyMetadataItem.from_dict()
ModelTaxonomyMetadataItem.to_yaml()
ModelTaxonomyMetadataItem.size()
ModelTaxonomyMetadataItem.update()
ModelTaxonomyMetadataItem.to_json()
ModelTaxonomyMetadataItem.to_json_file()
ModelTaxonomyMetadataItem.validate()
ModelTaxonomyMetadataItem.key
ModelTaxonomyMetadataItem.reset()
ModelTaxonomyMetadataItem.update()
ModelTaxonomyMetadataItem.validate()
ModelTaxonomyMetadataItem.value
UseCaseType
UseCaseType.ANOMALY_DETECTION
UseCaseType.BINARY_CLASSIFICATION
UseCaseType.CLUSTERING
UseCaseType.DIMENSIONALITY_REDUCTION
UseCaseType.IMAGE_CLASSIFICATION
UseCaseType.MULTINOMIAL_CLASSIFICATION
UseCaseType.NER
UseCaseType.OBJECT_LOCALIZATION
UseCaseType.OTHER
UseCaseType.RECOMMENDER
UseCaseType.REGRESSION
UseCaseType.SENTIMENT_ANALYSIS
UseCaseType.TIME_SERIES_FORECASTING
UseCaseType.TOPIC_MODELING
- ads.model.model_metadata_mixin module
- 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.model_version_set module
ModelVersionSet
ModelVersionSet.id
ModelVersionSet.project_id
ModelVersionSet.compartment_id
ModelVersionSet.name
ModelVersionSet.description
ModelVersionSet.freeform_tags
ModelVersionSet.defined_tags
ModelVersionSet.details_link
ModelVersionSet.create()
ModelVersionSet.update()
ModelVersionSet.delete()
ModelVersionSet.to_dict()
ModelVersionSet.from_id()
ModelVersionSet.from_ocid()
ModelVersionSet.from_name()
ModelVersionSet.from_dict()
ModelVersionSet.CONST_COMPARTMENT_ID
ModelVersionSet.CONST_DEFINED_TAG
ModelVersionSet.CONST_DESCRIPTION
ModelVersionSet.CONST_FREEFORM_TAG
ModelVersionSet.CONST_ID
ModelVersionSet.CONST_NAME
ModelVersionSet.CONST_PROJECT_ID
ModelVersionSet.LIFECYCLE_STATE_ACTIVE
ModelVersionSet.LIFECYCLE_STATE_DELETED
ModelVersionSet.LIFECYCLE_STATE_DELETING
ModelVersionSet.LIFECYCLE_STATE_FAILED
ModelVersionSet.attribute_map
ModelVersionSet.compartment_id
ModelVersionSet.create()
ModelVersionSet.defined_tags
ModelVersionSet.delete()
ModelVersionSet.description
ModelVersionSet.details_link
ModelVersionSet.freeform_tags
ModelVersionSet.from_dict()
ModelVersionSet.from_dsc_model_version_set()
ModelVersionSet.from_id()
ModelVersionSet.from_name()
ModelVersionSet.from_ocid()
ModelVersionSet.id
ModelVersionSet.kind
ModelVersionSet.list()
ModelVersionSet.model_add()
ModelVersionSet.models()
ModelVersionSet.name
ModelVersionSet.project_id
ModelVersionSet.status
ModelVersionSet.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
DataSciencePipeline
Pipeline
Pipeline.kind
Pipeline.name
Pipeline.id
Pipeline.step_details
Pipeline.dag_details
Pipeline.log_group_id
Pipeline.log_id
Pipeline.project_id
Pipeline.compartment_id
Pipeline.created_by
Pipeline.description
Pipeline.environment_variable
Pipeline.argument
Pipeline.maximum_runtime_in_minutes
Pipeline.shape_name
Pipeline.block_storage_size_in_gbs
Pipeline.shape_config_details
Pipeline.enable_service_log
Pipeline.service_log_id
Pipeline.status
Pipeline.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_SIZE
Pipeline.CONST_COMMAND_LINE_ARGUMENTS
Pipeline.CONST_COMPARTMENT_ID
Pipeline.CONST_CONFIGURATION_DETAILS
Pipeline.CONST_CONFIGURATION_OVERRIDE_DETAILS
Pipeline.CONST_CREATED_BY
Pipeline.CONST_DAG
Pipeline.CONST_DEFINED_TAGS
Pipeline.CONST_DESCRIPTION
Pipeline.CONST_DISPLAY_NAME
Pipeline.CONST_ENABLE_AUTO_LOG_CREATION
Pipeline.CONST_ENABLE_LOGGING
Pipeline.CONST_ENABLE_SERVICE_LOG
Pipeline.CONST_ENVIRONMENT_VARIABLES
Pipeline.CONST_FREEFROM_TAGS
Pipeline.CONST_ID
Pipeline.CONST_INFRA_CONFIG_DETAILS
Pipeline.CONST_LOG_CONFIGURATION_DETAILS
Pipeline.CONST_LOG_CONFIGURATION_OVERRIDE_DETAILS
Pipeline.CONST_LOG_GROUP_ID
Pipeline.CONST_LOG_ID
Pipeline.CONST_MAXIMUM_RUNTIME_IN_MINUTES
Pipeline.CONST_MEMORY_IN_GBS
Pipeline.CONST_OCPUS
Pipeline.CONST_PIPELINE_ID
Pipeline.CONST_PROJECT_ID
Pipeline.CONST_SERVICE
Pipeline.CONST_SERVICE_LOG_CATEGORY
Pipeline.CONST_SERVICE_LOG_ID
Pipeline.CONST_SHAPE_CONFIG_DETAILS
Pipeline.CONST_SHAPE_NAME
Pipeline.CONST_STEP_DETAILS
Pipeline.CONST_STEP_OVERRIDE_DETAILS
Pipeline.CONST_SYSTEM_TAGS
Pipeline.CONST_TYPE
Pipeline.LIFECYCLE_STATE_ACTIVE
Pipeline.LIFECYCLE_STATE_CREATING
Pipeline.LIFECYCLE_STATE_DELETED
Pipeline.LIFECYCLE_STATE_DELETING
Pipeline.LIFECYCLE_STATE_FAILED
Pipeline.argument
Pipeline.block_storage_size_in_gbs
Pipeline.compartment_id
Pipeline.create()
Pipeline.created_by
Pipeline.dag
Pipeline.delete()
Pipeline.description
Pipeline.download()
Pipeline.enable_service_log
Pipeline.environment_variable
Pipeline.from_dict()
Pipeline.from_id()
Pipeline.from_ocid()
Pipeline.id
Pipeline.kind
Pipeline.list()
Pipeline.log_group_id
Pipeline.log_id
Pipeline.maximum_runtime_in_minutes
Pipeline.name
Pipeline.project_id
Pipeline.run()
Pipeline.run_list()
Pipeline.service_log_id
Pipeline.shape_config_details
Pipeline.shape_name
Pipeline.show()
Pipeline.status
Pipeline.step_details
Pipeline.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
LogNotConfiguredError
LogType
PipelineRun
PipelineRun.pipeline
PipelineRun.status
PipelineRun.custom_logging
PipelineRun.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_logging
PipelineRun.delete()
PipelineRun.list()
PipelineRun.logs()
PipelineRun.pipeline
PipelineRun.service_logging
PipelineRun.show()
PipelineRun.status
PipelineRun.sync()
PipelineRun.to_svg()
PipelineRun.to_yaml()
PipelineRun.watch()
ShowMode
StepType
- ads.pipeline.ads_pipeline_step module
PipelineStep
PipelineStep.kind
PipelineStep.name
PipelineStep.job_id
PipelineStep.infrastructure
PipelineStep.runtime
PipelineStep.description
PipelineStep.maximum_runtime_in_minutes
PipelineStep.environment_variable
PipelineStep.argument
PipelineStep.depends_on
PipelineStep.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_ARGUMENTS
PipelineStep.CONST_DEPENDS_ON
PipelineStep.CONST_DESCRIPTION
PipelineStep.CONST_ENVIRONMENT_VARIABLES
PipelineStep.CONST_INFRASTRUCTURE
PipelineStep.CONST_JOB_ID
PipelineStep.CONST_KIND
PipelineStep.CONST_MAXIMUM_RUNTIME_IN_MINUTES
PipelineStep.CONST_NAME
PipelineStep.CONST_RUNTIME
PipelineStep.CONST_STEP_CONFIG_DETAILS
PipelineStep.CONST_STEP_INFRA_CONFIG_DETAILS
PipelineStep.argument
PipelineStep.depends_on
PipelineStep.description
PipelineStep.environment_variable
PipelineStep.from_dict()
PipelineStep.infrastructure
PipelineStep.job_id
PipelineStep.kind
PipelineStep.maximum_runtime_in_minutes
PipelineStep.name
PipelineStep.runtime
PipelineStep.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
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.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
AddressTypedFeature
CategoricalTypedFeature
ConstantTypedFeature
ContinuousTypedFeature
CreditCardTypedFeature
DateTimeTypedFeature
DiscreteTypedFeature
DocumentTypedFeature
GISTypedFeature
IPAddressTypedFeature
OrdinalTypedFeature
PhoneNumberTypedFeature
TypedFeature
UnknownTypedFeature
ZipcodeTypedFeature
- 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.