Relogger
========

This application, as illustrated in the :ref:`Figure below <Relogger Application Principle>`,
classifies descriptions into categorical classes (referenced data) within `Geoscience ANALYST`_.
The user can define up to 3 groups of categorical classes with descriptive names.
Subsequently, the application matches each description with the class that has the highest likelihood.
The application supports both single-label and multi-label classification, and can optionally provide confidence scores.
The output classification integrates seamlessly as referenced data in `Geoscience ANALYST`_,
immediately linked to the corresponding data object. Users can then easily visualize and refine the classification as necessary.

.. image:: ../images/relogger_principle.svg
    :name: Relogger Application Principle
    :align: center


.. _Geoscience ANALYST: https://www.mirageoscience.com/mining-industry-software/geoscience-analyst/

Interface
---------

You can run the application using the interface depicted in :ref:`Figure below <Relogger Interface>`.

.. image:: ../images/relogger_uijson.png
    :name: Relogger Interface
    :align: center

The interface contains the following parameters:

Data selection
~~~~~~~~~~~~~~

* **Drillhole data**: The drillhole group and the associated text data to relog.
* **Object**: The object containing the text data to relog.
* **Data**: The text data to relog.

Relogging Group 1
~~~~~~~~~~~~~~~~~

* **Title**: Title for the first group of relogging classes.
* **Classes**: The classes to use for relogging. They must be separated with commas. **The name of the classes must be descriptive as the relogging is based on their meaning**.

Relogging Group 2 (optional)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* **Title**: Title for the second group of relogging classes.
* **Classes**: Additional classes for relogging, separated by commas.

Relogging Group 3 (optional)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* **Title**: Title for the third group of relogging classes.
* **Classes**: Additional classes for relogging, separated by commas.

Main parameters
~~~~~~~~~~~~~~~

* **Add confidence**: When enabled, adds confidence scores to the relogging results. The confidence data will be named as 'title' + '_confidence'.The confidence score indicates if the model is confident (``high``) or hesitant (``low``) in its classification. This score is only indicative and should be used with caution.
* **Multi-label**: When enabled, allows multiple classes to be assigned to a single interval using multi-label classification. It results in one boolean data per class indicating whether the class was found or not.
* **Language model**: The language model to use for relogging. The available models are listed in the `Models Available <../index.rst>`_ table.

* **OK**: Clicking "OK" runs the application with the specified parameters.

Advanced parameters
~~~~~~~~~~~~~~~~~~~

.. image:: ../images/relogger_uijson_optional.png
    :name: Relogger Interface Optional
    :align: center

* **Context** (optional): The context to use for the relogging. It can be used to provide additional information to the model.

The application opens a console displaying the progress of the relogging.
Upon completion, the new classification is made available as a referenced Data within the `Geoscience ANALYST`_ project.

Results
-------

The results can be found in Geoscience ANALYST, as illustrated in the :ref:`figure below <Relogger Result>`. **Referenced Data** entries are created under the object selected in the application (``DrillholeData`` or ``Object`` in the :ref:`Interface <Relogger Interface>`). When multiple relogging groups are defined, separate referenced data entries are created for each group. If confidence scoring is enabled, additional confidence data will also be available.

.. image:: ../images/result_relogger.svg
    :name: Relogger Result
    :align: center