Metadata-Version: 2.1
Name: osc-transformer-presteps
Version: 0.1.6
Summary: OS-Climate Data Extraction Tool
Author-Email: David Besslich <90916810+DaBeIDS@users.noreply.github.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: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Project-URL: Homepage, https://github.com/os-climate/osc-transformer-presteps
Project-URL: Repository, https://github.com/os-climate/osc-transformer-presteps
Project-URL: Downloads, https://github.com/os-climate/osc-transformer-presteps/releases
Project-URL: Bug Tracker, https://github.com/os-climate/osc-transformer-presteps/issues
Project-URL: Documentation, https://github.com/os-climate/osc-transformer-presteps/tree/main/docs
Project-URL: Source Code, https://github.com/os-climate/osc-transformer-presteps
Requires-Python: <3.12,>=3.10
Requires-Dist: pdfminer>=20191125
Requires-Dist: pypdf>=4.0.0
Requires-Dist: numpy>=1.26.3
Requires-Dist: fastapi>=0.109.0
Requires-Dist: uvicorn>=0.27.0.post1
Requires-Dist: python-multipart>=0.0.6
Requires-Dist: streamlit>=1.12.0
Requires-Dist: altair<5
Requires-Dist: types-requests>=2.31.0.20240218
Requires-Dist: pydantic>=2.6.3
Requires-Dist: typer>=0.12.3
Requires-Dist: openpyxl>=3.1.4
Requires-Dist: scikit-learn>=1.5.2
Requires-Dist: rapidfuzz>=3.10.1
Provides-Extra: dev
Requires-Dist: pylint; extra == "dev"
Requires-Dist: toml; extra == "dev"
Requires-Dist: yapf; extra == "dev"
Requires-Dist: pdm; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: tox-pdm; extra == "dev"
Provides-Extra: test
Requires-Dist: pdm[pytest]; extra == "test"
Requires-Dist: pytest>=8.1.1; extra == "test"
Requires-Dist: pytest-cov>=5.0.0; extra == "test"
Description-Content-Type: text/x-rst

💬 **Important**

On June 26 2024, Linux Foundation announced the merger of its financial services umbrella, the Fintech Open Source Foundation (FINOS <https://finos.org>), with OS-Climate, an open source community dedicated to building data technologies, modelling, and analytic tools that will drive global capital flows into climate change mitigation and resilience; OS-Climate projects are in the process of transitioning to the FINOS governance framework <https://community.finos.org/docs/governance>; read more on finos.org/press/finos-join-forces-os-open-source-climate-sustainability-esg <https://finos.org/press/finos-join-forces-os-open-source-climate-sustainability-esg>_

=========================
OSC Transformer Pre-Steps
=========================

|osc-climate-project| |osc-climate-slack| |osc-climate-github| |pypi| |pdm| |PyScaffold| |OpenSSF Scorecard|

OS-Climate Transformer Pre-Steps Tool
=====================================

.. _notes:

This code provides you with a cli tool with the possibility to extract data from
a pdf to a json document and to create a training data set for a later usage in the
context of transformer models
to extract relevant information, but it can also be used independently.

Quick start
============

Install via PyPi
----------------

You can simply install the package via::

    $ pip install osc-transformer-presteps

Afterwards, you can use the tooling as a CLI tool by typing::

    $ osc-transformer-presteps

We are using Typer to provide a user-friendly CLI. All details and help will be shown within the CLI itself and are not described here in more detail.

Example 1: Extracting Data from PDFs
------------------------------------

Assume the folder structure is as follows:

.. code-block:: text

    project/
    ├-input/
    │ ├-file_1.pdf
    │ ├-file_2.pdf
    │ └─file_3.pdf
    ├-logs/
    └─output/

Now, after installing ``osc-transformer-presteps``, run the following command to extract data from the PDFs to JSON::

    $ osc-transformer-presteps extraction run-local-extraction 'input' --output-folder='output' --logs-folder='logs' --force

Note: The ``--force`` flag overcomes encryption. Please check if this is a legal action in your jurisdiction.

Example 2: Curating a New Training Data Set for Relevance Detector
---------------------------------------------------------------------------

To perform curation, you will need a KPI mapping file and an annotations file. Here are examples of such files:

**KPI Mapping File**:

.. list-table:: kpi_mapping.csv
   :header-rows: 1

   * - kpi_id
     - question
     - sectors
     - add_year
     - kpi_category
   * - 0
     - What is the company name?
     - "OG, CM, CU"
     - FALSE
     - TEXT

* **kpi_id**: The unique identifier for each KPI.
* **question**: The specific question being asked to extract relevant information.
* **sectors**: The industry sectors to which the KPI applies.
* **add_year**: Indicates whether to include the year in the extracted data (TRUE/FALSE).
* **kpi_category**: The category of the KPI, typically specifying the data type (e.g., TEXT).

**Annotation File**:

.. list-table:: annotations_file.xlsx
   :header-rows: 1

   * - company
     - source_file
     - source_page
     - kpi_id
     - year
     - answer
     - data_type
     - relevant_paragraphs
     - annotator
     - sector
   * - Royal Dutch Shell plc
     - Test.pdf
     - [1]
     - 1
     - 2019
     - 2019
     - TEXT
     - ["Sustainability Report 2019"]
     - 1qbit_edited_kpi_extraction_Carolin.xlsx
     - OG

* **company**: The name of the company being analyzed.
* **source_file**: The document from which data is extracted.
* **source_page**: The page number(s) containing the relevant information.
* **kpi_id**: The ID of the KPI associated with the data.
* **year**: The year to which the data refers.
* **answer**: The specific data or text extracted as an answer.
* **data_type**: The type of the extracted data (e.g., TEXT or TABLE).
* **relevant_paragraphs**: The paragraph(s) or context where the data was found.
* **annotator**: The person or tool that performed the annotation.
* **sector**: The industry sector the company belongs to.


You can find demo files in the ``demo/curation/input`` folder.

Assume the folder structure is as follows:

.. code-block:: text

    project/
    ├-input/
    │ ├-data_from_extraction/
    │ │ ├-file_1.json
    │ │ ├-file_2.json
    │ │ └─file_3.json
    │ ├-kpi_mapping/
    │ │ └─kpi_mapping.csv
    │ ├-annotations_file/
    │ │ └─annotations_file.xlsx
    ├-logs/
    └─output/

Now, you can run the following command to curate a new training data set::

    $ osc-transformer-presteps relevance-curation run-local-curation 'input/-data_from_extraction/file_1.json' 'input/annotations_file/annotations_file.xlsx' 'input/kpi_mapping/kpi_mapping.csv'

Note: The previous comment may need some adjustment when running on different machine like windows due to the slash.


Example 3: Curating a New Training Data Set for KPI Detector
---------------------------------------------------------------------------
To perform curation, you will need the extracted json files and kpi mappinf file and annotations file (the same as described above).

Assume the folder structure is as follows:

.. code-block:: text

    project/
    ├-input/
    │ ├-data_from_extraction/
    │ │ ├-file_1.json
    │ │ ├-file_2.json
    │ │ └─file_3.json
    │ ├-kpi_mapping/
    │ │ └─kpi_mapping.csv
    │ ├-annotations_file/
    │ │ └─annotations_file.xlsx
    │ ├-relevance_detection_file/
    │ │ └─relevance_detection.csv
    ├-logs/
    └─output/

Now, you can run the following command to curate a new training data set::

    $ osc-transformer-presteps kpi-curation run-local-kpi-curation  'input/annotations_file/' 'input/data_from_extraction/' 'output/' 'kpi_mapping/kpi_mapping_file.csv' 'relevance_detection_file/relevance_file.xlsx'  --val-ratio 0.2 --agg-annotation "" --find-new-answerable --create-unanswerable

Note: The previous comment may need some adjustment when running on different machine like windows due to the slash.

.. _Important Note on Annotations:

Important Note on Annotations
-------------------------------

When performing curation, it is crucial that all JSON files used for this process are listed in the ``demo/curation/input/test_annotation.xlsx`` file. Failure to include these files in the annotation file will result in corrupted output.

Ensure that every JSON file involved in the curation process is mentioned in the annotation file to maintain the integrity of the resulting output.


Developer space
================

Use Code Directly Without CLI via Github Repository
-----------------------------------------------------

First, clone the repository to your local environment::

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

We are using ``pdm`` to manage the packages and ``tox`` for a stable test framework.
First, install ``pdm`` (possibly in a virtual environment) via::

    $ pip install pdm

Afterwards, sync your system via::

    $ pdm sync

You will find multiple demos on how to proceed in the ``demo`` folder.

pdm
---

To add new dependencies, use ``pdm``. For example, you can add numpy via::

    $ pdm add numpy

For more detailed descriptions, check the `PDM project homepage <https://pdm-project.org/en/latest/>`_.

tox
---

For running linting tools, we use ``tox``. You can run this outside of your virtual environment::

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

This will automatically apply checks on your code and run the provided pytests. See more details on `tox <https://tox.wiki/en/4.16.0/>`_.

.. |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/os-climate/osc-transformer-presteps

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

.. |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/

.. |OpenSSF Scorecard| image:: https://api.scorecard.dev/projects/github.com/os-climate/osc-transformer-presteps/badge
  :alt: OpenSSF Scorecard
  :target: https://scorecard.dev/viewer/?uri=github.com/os-climate/osc-transformer-presteps
