ads package
Subpackages
- ads.automl package
- ads.catalog package
- ads.common package
- Submodules
- ads.common.card_identifier module
- ads.common.auth module
- ads.common.data module
- ads.common.model module
- ads.common.model_metadata module
- ads.common.decorator.runtime_dependency module
- 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
- 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
- ads.data_labeling.constants module
- ads.data_labeling.data_labeling_service module
- ads.data_labeling.metadata module
- 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
- ads.dataset.dataset_browser module
- ads.dataset.dataset_with_target module
- ads.dataset.exception module
- ads.dataset.factory module
- ads.dataset.feature_engineering_transformer module
- ads.dataset.feature_selection module
- ads.dataset.forecasting_dataset module
- ads.dataset.helper module
- 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
- ads.explanations package
- ads.feature_engineering package
- Submodules
- ads.feature_engineering.exceptions module
- ads.feature_engineering.feature_type_manager module
- ads.feature_engineering.accessor.dataframe_accessor module
- ads.feature_engineering.accessor.series_accessor module
- 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
- 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
- ads.jobs package
- ads.model.framework other package
- Submodules
- ads.model.artifact module
- ads.model.generic_model module
- ads.model.model_properties module
- 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
- ads.model.extractor.sklearn_extractor module
- ads.model.extractor.keras_extractor module
- ads.model.extractor.tensorflow_extractor module
- ads.model.extractor.pytorch_extractor module
- Module contents
- ads.model.deployment package
- ads.model.framework package
- ads.model.runtime package
- ads.oracledb package
- ads.secrets package
- 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_auth(auth='api_key', oci_config_location='~/.oci/config', profile='DEFAULT')
Enable/disable resource principal identity or keypair identity in a notebook session.
- Parameters
auth ({'api_key', 'resource_principal'}, default 'api_key') – Enable/disable resource principal identity or keypair identity in a notebook session
oci_config_location (str, default oci.config.DEFAULT_LOCATION, which is '~/.oci/config') – config file location
profile (str, default 'DEFAULT') – profile name for api keys config file
- 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.