.. index:: 
  !DocumentLibrary.unloadModel Method
  
.. _id3_document_document_library_unload_model_class_method:

===============================================================================
DocumentLibrary.unloadModel Method
===============================================================================

Module: :ref:`DocumentLibrary<id3_document_document_library_class>`

Definition
----------

Unloads a model from memory.


.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        @staticmethod
        unload_model(document_model: DocumentModel, processing_unit: ProcessingUnit) -> None

      **Parameters**

        .. line-block::

          ``document_model`` :ref:`DocumentModel<id3_document_document_model_enum>`
          :guilabel:`in` The AI model to be unloaded.

          ``processing_unit`` :ref:`ProcessingUnit<id3_document_processing_unit_enum>`
          :guilabel:`in` The processing unit used for the model.


      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        static void unloadModel(DocumentModel documentModel, ProcessingUnit processingUnit)

      **Parameters**

        .. line-block::

          ``documentModel`` :ref:`DocumentModel<id3_document_document_model_enum>`
          :guilabel:`in` The AI model to be unloaded.

          ``processingUnit`` :ref:`ProcessingUnit<id3_document_processing_unit_enum>`
          :guilabel:`in` The processing unit used for the model.


      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        public static void UnloadModel(DocumentModel documentModel, ProcessingUnit processingUnit)

      **Parameters**

        .. line-block::

          ``documentModel`` :ref:`DocumentModel<id3_document_document_model_enum>`
          :guilabel:`in` The AI model to be unloaded.

          ``processingUnit`` :ref:`ProcessingUnit<id3_document_processing_unit_enum>`
          :guilabel:`in` The processing unit used for the model.


      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        public static void unloadModel(DocumentModel documentModel, ProcessingUnit processingUnit) throws DocumentException

      **Parameters**

        .. line-block::

          ``documentModel`` :ref:`DocumentModel<id3_document_document_model_enum>`
          :guilabel:`in` The AI model to be unloaded.

          ``processingUnit`` :ref:`ProcessingUnit<id3_document_processing_unit_enum>`
          :guilabel:`in` The processing unit used for the model.


      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        public static func unloadModel(documentModel: DocumentModel, processingUnit: ProcessingUnit) throws

      **Parameters**

        .. line-block::

          ``documentModel`` :ref:`DocumentModel<id3_document_document_model_enum>`
          :guilabel:`in` The AI model to be unloaded.

          ``processingUnit`` :ref:`ProcessingUnit<id3_document_processing_unit_enum>`
          :guilabel:`in` The processing unit used for the model.


      **Exceptions**

        .. line-block::

          :ref:`DocumentException<id3_document_document_exception>`
          An error has occurred during Document Library execution.


    .. tab-item:: C
      :sync: C

      .. code:: C

        int id3DocumentLibrary_UnloadModel (
            id3DocumentModel eDocumentModel, 
            id3DocumentProcessingUnit eProcessingUnit)

      **Parameters**

        .. line-block::

          ``eDocumentModel`` :ref:`id3DocumentModel<id3_document_document_model_enum>`
          :guilabel:`in` The AI model to be unloaded.

          ``eProcessingUnit`` :ref:`id3DocumentProcessingUnit<id3_document_processing_unit_enum>`
          :guilabel:`in` The processing unit used for the model.


      **Returns**

        .. line-block::

          ``int``
          An error code.
          See :ref:`id3DocumentError<id3_document_document_error_enum>` file for the list of possible error codes.


