Metadata-Version: 2.1
Name: osc-transformer-based-extractor
Version: 0.1.5
Summary: OS-Climate Data Extraction Tool
Author-Email: Tanishq More <tanishq.more@investmentdataservices.com>
License:                                  Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
         
            TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
         
            1. Definitions.
         
               "License" shall mean the terms and conditions for use, reproduction,
               and distribution as defined by Sections 1 through 9 of this document.
         
               "Licensor" shall mean the copyright owner or entity authorized by
               the copyright owner that is granting the License.
         
               "Legal Entity" shall mean the union of the acting entity and all
               other entities that control, are controlled by, or are under common
               control with that entity. For the purposes of this definition,
               "control" means (i) the power, direct or indirect, to cause the
               direction or management of such entity, whether by contract or
               otherwise, or (ii) ownership of fifty percent (50%) or more of the
               outstanding shares, or (iii) beneficial ownership of such entity.
         
               "You" (or "Your") shall mean an individual or Legal Entity
               exercising permissions granted by this License.
         
               "Source" form shall mean the preferred form for making modifications,
               including but not limited to software source code, documentation
               source, and configuration files.
         
               "Object" form shall mean any form resulting from mechanical
               transformation or translation of a Source form, including but
               not limited to compiled object code, generated documentation,
               and conversions to other media types.
         
               "Work" shall mean the work of authorship, whether in Source or
               Object form, made available under the License, as indicated by a
               copyright notice that is included in or attached to the work
               (an example is provided in the Appendix below).
         
               "Derivative Works" shall mean any work, whether in Source or Object
               form, that is based on (or derived from) the Work and for which the
               editorial revisions, annotations, elaborations, or other modifications
               represent, as a whole, an original work of authorship. For the purposes
               of this License, Derivative Works shall not include works that remain
               separable from, or merely link (or bind by name) to the interfaces of,
               the Work and Derivative Works thereof.
         
               "Contribution" shall mean any work of authorship, including
               the original version of the Work and any modifications or additions
               to that Work or Derivative Works thereof, that is intentionally
               submitted to Licensor for inclusion in the Work by the copyright owner
               or by an individual or Legal Entity authorized to submit on behalf of
               the copyright owner. For the purposes of this definition, "submitted"
               means any form of electronic, verbal, or written communication sent
               to the Licensor or its representatives, including but not limited to
               communication on electronic mailing lists, source code control systems,
               and issue tracking systems that are managed by, or on behalf of, the
               Licensor for the purpose of discussing and improving the Work, but
               excluding communication that is conspicuously marked or otherwise
               designated in writing by the copyright owner as "Not a Contribution."
         
               "Contributor" shall mean Licensor and any individual or Legal Entity
               on behalf of whom a Contribution has been received by Licensor and
               subsequently incorporated within the Work.
         
            2. Grant of Copyright License. Subject to the terms and conditions of
               this License, each Contributor hereby grants to You a perpetual,
               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
               copyright license to reproduce, prepare Derivative Works of,
               publicly display, publicly perform, sublicense, and distribute the
               Work and such Derivative Works in Source or Object form.
         
            3. Grant of Patent License. Subject to the terms and conditions of
               this License, each Contributor hereby grants to You a perpetual,
               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
               (except as stated in this section) patent license to make, have made,
               use, offer to sell, sell, import, and otherwise transfer the Work,
               where such license applies only to those patent claims licensable
               by such Contributor that are necessarily infringed by their
               Contribution(s) alone or by combination of their Contribution(s)
               with the Work to which such Contribution(s) was submitted. If You
               institute patent litigation against any entity (including a
               cross-claim or counterclaim in a lawsuit) alleging that the Work
               or a Contribution incorporated within the Work constitutes direct
               or contributory patent infringement, then any patent licenses
               granted to You under this License for that Work shall terminate
               as of the date such litigation is filed.
         
            4. Redistribution. You may reproduce and distribute copies of the
               Work or Derivative Works thereof in any medium, with or without
               modifications, and in Source or Object form, provided that You
               meet the following conditions:
         
               (a) You must give any other recipients of the Work or
                   Derivative Works a copy of this License; and
         
               (b) You must cause any modified files to carry prominent notices
                   stating that You changed the files; and
         
               (c) You must retain, in the Source form of any Derivative Works
                   that You distribute, all copyright, patent, trademark, and
                   attribution notices from the Source form of the Work,
                   excluding those notices that do not pertain to any part of
                   the Derivative Works; and
         
               (d) If the Work includes a "NOTICE" text file as part of its
                   distribution, then any Derivative Works that You distribute must
                   include a readable copy of the attribution notices contained
                   within such NOTICE file, excluding those notices that do not
                   pertain to any part of the Derivative Works, in at least one
                   of the following places: within a NOTICE text file distributed
                   as part of the Derivative Works; within the Source form or
                   documentation, if provided along with the Derivative Works; or,
                   within a display generated by the Derivative Works, if and
                   wherever such third-party notices normally appear. The contents
                   of the NOTICE file are for informational purposes only and
                   do not modify the License. You may add Your own attribution
                   notices within Derivative Works that You distribute, alongside
                   or as an addendum to the NOTICE text from the Work, provided
                   that such additional attribution notices cannot be construed
                   as modifying the License.
         
               You may add Your own copyright statement to Your modifications and
               may provide additional or different license terms and conditions
               for use, reproduction, or distribution of Your modifications, or
               for any such Derivative Works as a whole, provided Your use,
               reproduction, and distribution of the Work otherwise complies with
               the conditions stated in this License.
         
            5. Submission of Contributions. Unless You explicitly state otherwise,
               any Contribution intentionally submitted for inclusion in the Work
               by You to the Licensor shall be under the terms and conditions of
               this License, without any additional terms or conditions.
               Notwithstanding the above, nothing herein shall supersede or modify
               the terms of any separate license agreement you may have executed
               with Licensor regarding such Contributions.
         
            6. Trademarks. This License does not grant permission to use the trade
               names, trademarks, service marks, or product names of the Licensor,
               except as required for reasonable and customary use in describing the
               origin of the Work and reproducing the content of the NOTICE file.
         
            7. Disclaimer of Warranty. Unless required by applicable law or
               agreed to in writing, Licensor provides the Work (and each
               Contributor provides its Contributions) on an "AS IS" BASIS,
               WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
               implied, including, without limitation, any warranties or conditions
               of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
               PARTICULAR PURPOSE. You are solely responsible for determining the
               appropriateness of using or redistributing the Work and assume any
               risks associated with Your exercise of permissions under this License.
         
            8. Limitation of Liability. In no event and under no legal theory,
               whether in tort (including negligence), contract, or otherwise,
               unless required by applicable law (such as deliberate and grossly
               negligent acts) or agreed to in writing, shall any Contributor be
               liable to You for damages, including any direct, indirect, special,
               incidental, or consequential damages of any character arising as a
               result of this License or out of the use or inability to use the
               Work (including but not limited to damages for loss of goodwill,
               work stoppage, computer failure or malfunction, or any and all
               other commercial damages or losses), even if such Contributor
               has been advised of the possibility of such damages.
         
            9. Accepting Warranty or Additional Liability. While redistributing
               the Work or Derivative Works thereof, You may choose to offer,
               and charge a fee for, acceptance of support, warranty, indemnity,
               or other liability obligations and/or rights consistent with this
               License. However, in accepting such obligations, You may act only
               on Your own behalf and on Your sole responsibility, not on behalf
               of any other Contributor, and only if You agree to indemnify,
               defend, and hold each Contributor harmless for any liability
               incurred by, or claims asserted against, such Contributor by reason
               of your accepting any such warranty or additional liability.
         
            END OF TERMS AND CONDITIONS
         
            APPENDIX: How to apply the Apache License to your work.
         
               To apply the Apache License to your work, attach the following
               boilerplate notice, with the fields enclosed by brackets "{}"
               replaced with your own identifying information. (Don't include
               the brackets!)  The text should be enclosed in the appropriate
               comment syntax for the file format. We also recommend that a
               file or class name and description of purpose be included on the
               same "printed page" as the copyright notice for easier
               identification within third-party archives.
         
            Copyright {yyyy} {name of copyright owner}
         
            Licensed under the Apache License, Version 2.0 (the "License");
            you may not use this file except in compliance with the License.
            You may obtain a copy of the License at
         
                http://www.apache.org/licenses/LICENSE-2.0
         
            Unless required by applicable law or agreed to in writing, software
            distributed under the License is distributed on an "AS IS" BASIS,
            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
            See the License for the specific language governing permissions and
            limitations under the License.
         
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Project-URL: Homepage, https://github.com/os-climate/osc-transformer-based-extractor
Project-URL: Repository, https://github.com/os-climate/osc-transformer-based-extractor
Project-URL: Downloads, https://github.com/os-climate/osc-transformer-based-extractor/releases
Project-URL: Bug Tracker, https://github.com/os-climate/osc-transformer-based-extractor/issues
Project-URL: Documentation, https://github.com/os-climate/osc-transformer-based-extractor/tree/main/docs
Project-URL: Source Code, https://github.com/os-climate/osc-transformer-based-extractor
Requires-Python: >=3.9
Requires-Dist: torch<=2.3.1
Requires-Dist: pandas>=2.2.2
Requires-Dist: tokenizers>=0.19.1
Requires-Dist: transformers>=4.40.0
Requires-Dist: pre-commit>=3.7.0
Requires-Dist: pytest>=8.2.1
Requires-Dist: pytest-cov>=5.0.0
Requires-Dist: scikit-learn>=1.5.0
Requires-Dist: accelerate>=0.31.0
Requires-Dist: typer[all]>=0.12.3
Requires-Dist: rich>=13.7.1
Requires-Dist: numpy<2.0.0
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: datasets>=2.20.0
Provides-Extra: dev
Requires-Dist: pylint; extra == "dev"
Requires-Dist: toml; extra == "dev"
Requires-Dist: yapf; extra == "dev"
Requires-Dist: pdm; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Description-Content-Type: text/x-rst

#############################################
OSC Transformer Based Extractor
#############################################

|osc-climate-project| |osc-climate-slack| |osc-climate-github| |pypi| |build-status| |pdm| |PyScaffold|

***********************************
OS-Climate Data Extraction Tool
***********************************

This project provides a CLI tool and Python scripts to train Transformer models (via Hugging Face) for two primary tasks:  
1. **Relevance Detection**: Determines if a question-context pair is relevant.  
2. **KPI Detection**: Fine-tunes models to extract key performance indicators (KPIs) from datasets like annual reports and perform inference.

Quick Start
^^^^^^^^^^^^^

To install the tool, use pip:

.. code-block:: shell

    $ pip install osc-transformer-based-extractor

After installation, you can access the CLI tool with:

.. code-block:: shell

    $ osc-transformer-based-extractor

This command will show the available commands and help via Typer, our CLI library.

Commands and Workflow
^^^^^^^^^^^^^^^^^^^^^^^

1. Relevance Detection
--------------------------

**Fine-tuning the Model:**

Assume your project structure looks like this:

.. code-block:: text

    project/
    │
    ├── kpi_mapping.csv
    ├── training_data.csv
    ├── data/              
    │   └── (JSON files for inference)
    ├── model/             
    │   └── (Model-related files)
    ├── saved__model/      
    │   └── (Output from training)
    ├── output/            
    │   └── (Results from inference)

Use the following command to fine-tune the model:

.. code-block:: shell

    $ osc-transformer-based-extractor relevance-detector fine-tune \
      --data_path "project/training_data.csv" \
      --model_name "bert-base-uncased" \
      --num_labels 2 \
      --max_length 128 \
      --epochs 3 \
      --batch_size 16 \
      --output_dir "project/saved__model/" \
      --save_steps 500

**Running Inference:**

.. code-block:: shell

    $ osc-transformer-based-extractor relevance-detector perform-inference \
      --folder_path "project/data/" \
      --kpi_mapping_path "project/kpi_mapping.csv" \
      --output_path "project/output/" \
      --model_path "project/model/" \
      --tokenizer_path "project/model/" \
      --threshold 0.5

2. KPI Detection
---------------------

The KPI detection functionality includes **fine-tuning** and **inference**.

**Fine-tuning the KPI Model:**

Assume your project structure looks like this:

.. code-block:: text

    project/
    │
    ├── kpi_mapping.csv              
    ├── training_data.csv             
    │
    ├── model/                        
    │   └── (model-related files, e.g., tokenizer, config, checkpoints)
    │
    ├── saved__model/                 
    │   └── (Folder to store output from fine-tuning)
    │
    ├── output/                     
    │   └── (output files, e.g., inference_results.xlsx)


.. code-block:: shell

    $ osc-transformer-based-extractor kpi-detection fine-tune \
        --data_path "project/training_data.csv" \
        --model_name "bert-base-uncased" \
        --max_length 128 \
        --epochs 3 \
        --batch_size 16 \
        --learning_rate 5e-5 \
        --output_dir "project/saved__model/" \
        --save_steps 500


**Performing Inference:**

.. code-block:: shell

    $ osc-transformer-based-extractor kpi-detection inference \
        --data_file_path "project/data/input_dataset.csv" \
        --output_path "project/output/inference_results.xlsx" \
        --model_path "project/model/"


Training Data Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. Relevance Detection Training File:

The training file should have the following columns:
- ``Question``
- ``Context``
- ``Label``

Example:

.. list-table:: Training Data Example
   :header-rows: 1

   * - Question
     - Context
     - Label
   * - What is the company name?
     - The Company is exposed to a risk...
     - 0

2. KPI Detection Training File:

For KPI detection, the dataset should have these additional columns:

.. list-table:: KPI Detection Training Example
   :header-rows: 1

   * - Question
     - Context
     - Label
     - Company
     - Source File
     - KPI ID
     - Year
     - Answer
     - Data Type
   * - What is the company name?
     - ...
     - 0
     - NOVATEK
     - 04_NOVATEK_AR_2016_ENG_11.pdf
     - 0
     - 2016
     - PAO NOVATEK
     - TEXT

3. KPI Mapping File:

.. list-table:: KPI Mapping File Example
   :header-rows: 1

   * - kpi_id
     - question
     - sectors
     - add_year
     - kpi_category
   * - 1
     - In which year was the annual report...
     - OG, CM, CU
     - FALSE
     - TEXT

Developer Notes
^^^^^^^^^^^^^^^^^

Local Development
----------------------

Clone the repository:

.. code-block:: shell

    $ git clone https://github.com/os-climate/osc-transformer-based-extractor/

We use **pdm** for package management and **tox** for testing.

1. Install ``pdm``:

   .. code-block:: shell

      $ pip install pdm

2. Sync dependencies:

   .. code-block:: shell

      $ pdm sync

3. Add new packages (e.g., numpy):

   .. code-block:: shell

      $ pdm add numpy

4. Run ``tox`` for linting and testing:

   .. code-block:: shell

      $ pip install tox
      $ tox -e lint
      $ tox -e test

Contributing
^^^^^^^^^^^^^^

We welcome contributions! Please fork the repository and submit a pull request.  
Ensure you sign off each commit with the **Developer Certificate of Origin (DCO)**.  
Read more: http://developercertificate.org/.

Governance Transition
^^^^^^^^^^^^^^^^^^^^^^^^

On June 26, 2024, the **Linux Foundation** announced the merger of **FINOS** with OS-Climate.  
Projects are now transitioning to the [FINOS governance framework](https://community.finos.org/docs/governance).

Shields
^^^^^^^^^

|osc-climate-project| |osc-climate-slack| |osc-climate-github| |pypi| |build-status| |pdm| |PyScaffold|

.. |osc-climate-project| image:: https://img.shields.io/badge/OS-Climate-blue
   :alt: An OS-Climate Project
   :target: https://os-climate.org/

.. |osc-climate-slack| image:: https://img.shields.io/badge/slack-osclimate-brightgreen.svg?logo=slack
   :alt: Join OS-Climate on Slack
   :target: https://os-climate.slack.com

.. |osc-climate-github| image:: https://img.shields.io/badge/GitHub-100000?logo=github&logoColor=white
   :alt: Source code on GitHub
   :target: https://github.com/ModeSevenIndustrialSolutions/osc-data-extractor

.. |pypi| image:: https://img.shields.io/pypi/v/osc-data-extractor.svg
   :alt: PyPI package
   :target: https://pypi.org/project/osc-data-extractor/

.. |build-status| image:: https://api.cirrus-ci.com/github/os-climate/osc-data-extractor.svg?branch=main
   :alt: Build Status
   :target: https://cirrus-ci.com/github/os-climate/osc-data-extractor

.. |pdm| image:: https://img.shields.io/badge/PDM-Project-purple
   :alt: Built using PDM
   :target: https://pdm-project.org/latest/

.. |PyScaffold| image:: https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold
   :alt: Project generated with PyScaffold
   :target: https://pyscaffold.org/
