.. _l-methods: Methods ======= .. contents:: :local: :depth: 1 Summary +++++++ +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | method | class parent | truncated documentation | +=======================================================================================================================+=====================+========================================================================================================================+ | :py:meth:`__init__ ` | AuthMiddleware | | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | BaseLogging | | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MachineLearningPost | | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MLStorage | | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | ZipStorage | | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | MLStoragePost | | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | JsonError | | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_check_name ` | MLStorage | A name is valid if it is a variable name or a filename if *data* is True. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_check_name ` | ZipStorage | A name is valid if it is a variable name or a filename if *data* is True. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_import ` | MLStorage | Imports the main module for one model. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_load ` | MachineLearningPost | | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_logerrorinfo ` | BaseLogging | Logs any king of data into the logs. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_makedirs ` | MLStorage | Creates a subfolder and add a file ``__init__.py``. The function overwrites it file ``__init__.py`` to let ... | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_makedirs ` | ZipStorage | Creates a subfolder and add a file ``__init__.py``. The function overwrites it file ``__init__.py`` to let ... | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_predict ` | MLStoragePost | Stores the model in the storage. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_predict_single ` | MachineLearningPost | | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_store ` | MLStoragePost | Stores the model in the storage. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_token_is_valid ` | AuthMiddleware | Decides if it is valid or not. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`add ` | MLStorage | Adds a project based on the data. A project which already exists cannot be added. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`add ` | ZipStorage | Adds a project based on the data. A project which already exists cannot be added. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`call_predict ` | MLStorage | Calls method *restapi_predict* from a stored script *python*. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`call_version ` | MLStorage | Calls method *restapi_version* from a stored script *python*. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`check_single ` | MachineLearningPost | Checks the sequence load + predict returns something with the given observations. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`duration ` | BaseLogging | Get the duration since :meth:`save_time` was called. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`empty_cache ` | MLStorage | Removes one place in the cache if the cache is full. Sort them by last access. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`enumerate_names ` | MLStorage | Returns the list of sub folders. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`enumerate_names ` | ZipStorage | Returns the list of sub folders. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`error ` | BaseLogging | Logs any king of data into the logs. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`exists ` | MLStorage | Tells if project *name* exists. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`exists ` | ZipStorage | Tells if project *name* exists. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get ` | MLStorage | Retrieves a project based on its name. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get ` | ZipStorage | Retrieves a project based on its name. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_full_name ` | MLStorage | Returns the full name of a project. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_full_name ` | ZipStorage | Returns the full name of a project. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_metadata ` | MLStorage | Restores the data procuded by *verify_data*. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`get_metadata ` | ZipStorage | Restores the data procuded by *verify_data*. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`info ` | BaseLogging | Logs any king of data into the logs. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`load_model ` | MLStorage | Loads a model into the cache if not loaded and returns it. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`on_post ` | MachineLearningPost | | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`on_post ` | MLStoragePost | Processes a :epkg:`POST` request. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`parse_auth_token_from_request ` | AuthMiddleware | Parses and returns Auth token from the request header. Raises `falcon.HTTPUnauthoried exception` with proper error ... | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`process_request ` | AuthMiddleware | Processes an authentification request. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`save_time ` | BaseLogging | Saves the times to get a duration later. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`verify_data ` | MLStorage | Performs verifications to ensure the data to store is ok. The storages expects to find at least one script ... | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+ | :meth:`verify_data ` | ZipStorage | Performs verifications to ensure the data to store is ok. | +-----------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------+