caikit
CAIKit is an AI toolkit that enables AI users to consume stable task-specific model APIs while enabling AI developers build algorithms and models in a modular/composable framework.
Subpackages
caikit.config
caikit.core
caikit.core.augmentors
caikit.core.data_model
caikit.core.data_model.data_backends
caikit.core.data_model.protobufs
caikit.core.data_model.streams
caikit.core.data_model.base
caikit.core.data_model.dataobject
caikit.core.data_model.enums
caikit.core.data_model.json_dict
caikit.core.data_model.package
caikit.core.data_model.producer
caikit.core.data_model.timestamp
caikit.core.data_model.training_status
caikit.core.exceptions
caikit.core.model_management
caikit.core.model_management.factories
caikit.core.model_management.local_model_finder
caikit.core.model_management.local_model_initializer
caikit.core.model_management.local_model_trainer
caikit.core.model_management.model_finder_base
caikit.core.model_management.model_initializer_base
caikit.core.model_management.model_trainer_base
caikit.core.model_management.multi_model_finder
caikit.core.model_management.multi_model_initializer
caikit.core.module_backends
caikit.core.modules
caikit.core.signature_parsing
caikit.core.toolkit
caikit.core.toolkit.concurrency
caikit.core.toolkit.errors
caikit.core.toolkit.compatibility
caikit.core.toolkit.error_handler
caikit.core.toolkit.factory
caikit.core.toolkit.fileio
caikit.core.toolkit.logging
caikit.core.toolkit.name_tools
caikit.core.toolkit.quality_evaluation
caikit.core.toolkit.reversible_hasher
caikit.core.toolkit.serializers
caikit.core.toolkit.sync_to_async
caikit.core.toolkit.wip_decorator
caikit.core.model_manager
caikit.core.registries
caikit.core.task
caikit.interfaces
caikit.runtime
caikit.runtime.client
caikit.runtime.http_server
caikit.runtime.interceptors
caikit.runtime.metrics
caikit.runtime.model_management
caikit.runtime.protobufs
caikit.runtime.service_generation
caikit.runtime.servicers
caikit.runtime.servicers.global_predict_servicer
caikit.runtime.servicers.global_train_servicer
caikit.runtime.servicers.info_servicer
caikit.runtime.servicers.model_management_servicer
caikit.runtime.servicers.model_runtime_servicer
caikit.runtime.servicers.model_train_servicer
caikit.runtime.servicers.training_management_servicer
caikit.runtime.types
caikit.runtime.utils
caikit.runtime.work_management
caikit.runtime.__main__
caikit.runtime.dump_services
caikit.runtime.grpc_server
caikit.runtime.names
caikit.runtime.server_base
caikit.runtime.service_factory
caikit.runtime.train
Submodules
Package Contents
Functions
|
Configure caikit for your usage! |
|
Get the caikit configuration |
|
Apply this decorator to any class that should be treated as a caikit module |
Attributes
- caikit.configure(config_yml_path: str | None = None, config_dict: Dict[str, Any] | None = None)[source]
Configure caikit for your usage! Merges into the internal aconfig.Config object with overrides from multiple sources.
- Sources, last takes precedence:
The existing configuration from calls to caikit.configure()
The config from config_yml_path
The config from config_dict
- The config files specified in the config_files configuration
(NB: This may be set by the CONFIG_FILES environment variable)
Environment variables, in ALL_CAPS_SNAKE_FORMAT
- Args:
- config_yml_path (Optional[str]): The path to the base configuration yaml
with overrides for your usage.
config_dict (Optional[Dict]): Config overrides in dictionary form
- Returns: None: This only sets the config object that is returned by
caikit.get_config()
- caikit.extract
- caikit.get_model_future
- caikit.load
- caikit.module(id=None, name=None, version=None, task: Type[caikit.core.task.TaskBase] = None, tasks: List[Type[caikit.core.task.TaskBase]] | None = None, backend_type='LOCAL', base_module: str | Type[caikit.core.modules.base.ModuleBase] = None, backend_config_override: Dict | None = None)[source]
- Apply this decorator to any class that should be treated as a caikit module
(i.e., extends`{caikit.core.ModuleBase}) and registered with caikit.core so that the library “knows” the class is a caikit module and is capable of loading instances of the module.
- Args:
- id: str
A UUID to use when registering this module with caikit.core Not required if based on another caikit module using base_module
- name: str
A human-readable name for the module Not required if based on another caikit module using base_module
- version: str
A SemVer for the module Not required if based on another caikit module using base_module
- task: Type[TaskBase]
An ML task class that this module is an implementation for Not required if based on another caikit module using base_module, or if multiple tasks are specified using tasks.
- tasks: Optional[List[Type[TaskBase]]
List of ML task classes that this module implements.
- backend_type: backend_type
Associated backend type for the module. Default: LOCAL
- base_module: str | ModuleBase
If this module is based on a different caikit module, provide name of the base module. Default: None
- backend_config_override: Dict
Dictionary containing configuration required for the specific backend. Default: None
- Returns:
A decorated version of the class to which it was applied, after registering the class as a valid module with caikit.core
- caikit.resolve_and_load
- caikit.train
- caikit.__version__ = 'unknown'