text2sql-eval-toolkit 1.0.0__tar.gz

text2sql_eval_toolkit-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2025 IBM Corporation
+
+   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.

text2sql_eval_toolkit-1.0.0/PKG-INFO

@@ -0,0 +1,382 @@
+Metadata-Version: 2.4
+Name: text2sql-eval-toolkit
+Version: 1.0.0
+Summary: A toolkit for evaluating text-to-SQL pipelines
+Author-email: Oktie Hassanzadeh <lastname@us.ibm.com>
+License: MIT
+Project-URL: Homepage, https://github.com/IBM/text2sql-eval-toolkit
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ibm_watsonx_ai>=1.3.30
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: requests>=2.32.4
+Requires-Dist: sqlalchemy>=2.0.41
+Requires-Dist: sqlparse>=0.5.3
+Requires-Dist: unitxt>=1.26.1
+Requires-Dist: psycopg2-binary>=2.9.10
+Requires-Dist: sqlglot>=27.0.0
+Requires-Dist: asyncpg>=0.30.0
+Requires-Dist: setuptools>=77.0.3
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: func-timeout>=4.3.5
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: matplotlib>=3.10.5
+Requires-Dist: python-dotenv>=1.1.1
+Requires-Dist: langgraph>=0.2.0
+Requires-Dist: langchain-core>=0.3.0
+Requires-Dist: openai>=1.0.0
+Provides-Extra: db2
+Requires-Dist: ibm-db>=3.2.6; extra == "db2"
+Requires-Dist: ibm-db-sa>=0.4.0; extra == "db2"
+Requires-Dist: sqlalchemy>=2.0; extra == "db2"
+Provides-Extra: mysql
+Requires-Dist: pymysql>=1.1.1; extra == "mysql"
+Requires-Dist: aiomysql>=0.2.0; extra == "mysql"
+Requires-Dist: greenlet>=3.0.0; extra == "mysql"
+Requires-Dist: cryptography>=45.0.6; extra == "mysql"
+Provides-Extra: presto
+Requires-Dist: pyhive>=0.7.0; extra == "presto"
+Requires-Dist: presto-python-client>=0.8.4; extra == "presto"
+Provides-Extra: notebook
+Requires-Dist: jupyter>=1.0.0; extra == "notebook"
+Requires-Dist: nbconvert>=7.0.0; extra == "notebook"
+Dynamic: license-file
+
+# Text-to-SQL Evaluation Toolkit
+
+> **A modular framework for evaluating natural language to SQL systems**  
+> Supports execution-based metrics, multiple ground truths, LLM-as-judge, and rich error analysis.
+
+Text-to-SQL systems aim to translate natural language questions into executable SQL queries, enabling intuitive access to structured data. While recent advances in large language models have significantly improved generation quality, evaluating these systems remains a complex and critical challenge.
+
+*Why an Evaluation Toolkit?*
+
+Assessing the correctness and utility of generated SQL queries requires more than simple string matching—it demands a flexible, rigorous framework that accounts for semantic equivalence, execution behavior, and real-world variability in query formulation. This toolkit was designed to address key limitations in existing approaches and provide a comprehensive solution for researchers and developers.
+
+### Key Challenges in Evaluation
+
+- **SQL Semantics Are Subtle**: Minor syntactic differences can lead to major semantic changes—or none at all. Traditional string-based metrics often fail to capture this nuance.
+- **Execution-Based Validation Is Inconsistent**: Existing implementations often expect exact column sets, even when the question allows flexibility. For example, a query asking for a list of customers might return IDs, names, or both—all valid answers, yet not always recognized as such.
+- **Lack of Unified Standards**: There is no widely adopted, unified implementation for execution-based evaluation, leading to fragmented and sometimes misleading results.
+- **Multiple Valid SQLs**: Many questions have more than one correct SQL formulation. This toolkit supports multiple ground truth queries to reflect that reality.
+- **LLM-as-Judge Support**: In cases where ground truth is unavailable or traditional metrics fall short, the toolkit enables using LLMs as judges—a surprisingly reliable method for assessing query correctness and relevance.
+- **Error Analysis and Visualization**: Understanding *why* a model fails is just as important as knowing *that* it fails. The toolkit includes scripts and notebooks for summarizing results, visualizing performance, and performing detailed error analysis.
+
+### What This Toolkit Offers
+
+- Modular components for inference, execution, evaluation, profiling, and analysis
+- Support for multiple benchmarks and flexible configurations
+- Extensible metrics and evaluation strategies
+- Tools for debugging and improving model performance
+- A practical framework for both academic research and production-level benchmarking
+
+Whether you're building new models, comparing existing ones, or diagnosing performance bottlenecks, this toolkit provides the resources needed to evaluate text-to-SQL systems with rigor and clarity.
+
+## Components
+
+<p align="center">
+  <img src="toolkit.png" alt="Text-to-SQL Toolkit Components" width="500"/>
+</p>
+
+- **Evaluation** ([`scripts/evaluation`](scripts/evaluation)/`src/evaluation.py`): Includes a script and library for evaluating text-to-SQL model outputs using various metrics. See [`scripts/evaluation/README.md`](scripts/evaluation/README.md) for details.
+- **Text-to-SQL Inference** ([`scripts/inference`](scripts/inference)): Provides a simple LLM inference pipeline for generating SQL queries from natural language inputs. Run `python scripts/inference/run_inference.py -h` for more information.
+- **SQL Execution** ([`scripts/execution`](scripts/execution)): Runs the ground truth and predicted SQLs for a given benchmark and saves the dataframes for evaluation and error analysis. Run `python scripts/execution/run_execution.py -h` for more information.
+- **Results and Error Analysis** ([`scripts/analysis`](`scripts/analysis`)): Contains scripts and utilities for analyzing evaluation results, identifying common error patterns, and generating summary statistics and visualizations. Useful for debugging and improving model performance.
+- **SQL Profiling** ([`scripts/profiling`](`scripts/profiling`)) tools to profile SQL queries to gather query characteristics to facilitate better analysis of results and errors.
+
+## Setup
+
+### Prerequisites
+
+- Python 3.11 or higher
+- [UV](https://github.com/astral-sh/uv) package manager (recommended) or pip/conda
+
+### Installing UV (Recommended)
+
+UV is a fast Python package manager that makes setup much quicker:
+
+```bash
+# macOS/Linux
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Or using pip
+pip install uv
+
+# Or using Homebrew (macOS)
+brew install uv
+```
+
+## Installation
+
+### From PyPI
+
+```bash
+pip install text2sql-eval-toolkit
+
+# Optional: install database-specific extras
+pip install "text2sql-eval-toolkit[mysql,presto,db2]"
+```
+
+### From source (recommended for development)
+
+Using UV:
+
+```bash
+# Clone the repository
+git clone https://github.com/IBM/text2sql-eval-toolkit.git
+cd text2sql-eval-toolkit
+
+# Create virtual environment and install dependencies
+uv venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+
+# Install the package in editable mode
+uv pip install -e .
+
+# Optional: Install with database-specific dependencies
+uv pip install -e ".[mysql,presto,db2]"
+```
+
+Using pip/conda:
+
+```bash
+# Create conda environment (or use venv)
+conda create -n evaltoolkit python=3.12
+conda activate evaltoolkit
+
+# Clone and install
+git clone https://github.com/IBM/text2sql-eval-toolkit.git
+cd text2sql-eval-toolkit
+pip install -e .
+```
+
+## Additional Requirements
+
+To use features that rely on LLM inference, you need to set the required environment variables for the relevant services. For watsonx.ai, this includes setting the following environment variables: `WATSONX_APIKEY`, `WATSONX_API_BASE`, and `WATSONX_PROJECTID`. See [env.example](env.example) for all available configuration options.
+
+### Benchmarks
+
+The toolkit comes with pre-defined public benchmarks including BIRD-SQL, Spider, Beaver, and Archer. These benchmarks require initial setup such as downloading databases or configuring connection strings. The toolkit also includes smaller test benchmarks (subsets of the full benchmarks) for quick validation and CI/CD pipelines.
+
+**📚 See [data/benchmarks/README.md](data/benchmarks/README.md) for complete benchmark details, setup instructions, and configuration.**
+
+## Usage
+
+### Using the library API
+
+After installation you can import the toolkit and use both low-level and high-level evaluation APIs:
+
+**Evaluate a single prediction record in memory**
+
+```python
+from text2sql_eval_toolkit import evaluate_prediction, parse_dataframe, get_gt_sqls
+
+# record comes from a benchmark JSON entry, prediction from your model
+record = {
+    "id": "q1",
+    "sql": "SELECT * FROM customers",
+    "gt_df": some_serialized_dataframe,  # JSON in pandas orient='split' format
+}
+prediction = {
+    "predicted_sql": "SELECT * FROM customers",
+    "predicted_df": some_serialized_dataframe,  # same format
+}
+
+result = evaluate_prediction(record, prediction)
+print(result["subset_non_empty_execution_accuracy"])
+```
+
+**Evaluate a predictions JSON file**
+
+```python
+from text2sql_eval_toolkit import evaluate_predictions
+
+data, summary_df = evaluate_predictions(
+    input_file="data/results/my-benchmark-predictions.json",
+)
+print(summary_df.head())
+```
+
+**Run evaluation for a known benchmark ID**
+
+```python
+from text2sql_eval_toolkit import get_available_benchmarks, run_evaluation
+
+print(get_available_benchmarks())  # uses packaged benchmark metadata
+data, summary_df = run_evaluation("bird_mini_dev_sqlite")
+print(summary_df[["subset_non_empty_execution_accuracy_avg"]])
+```
+
+**Run SQL execution for a benchmark before evaluation**
+
+```python
+from text2sql_eval_toolkit import run_execution
+
+# Requires appropriate DB connection env vars (e.g., POSTGRES_CONNECTION_STRING)
+run_execution("bird_mini_dev_postgres")
+```
+
+**Use the inference pipelines**
+
+```python
+from text2sql_eval_toolkit import LLMSQLGenerationPipeline, AgenticSQLGenerationPipeline
+
+pipeline = LLMSQLGenerationPipeline()
+pipeline.run_pipeline(
+    benchmark_id="bird_mini_dev_sqlite",
+    model_name="wxai:ibm/granite-34b-code-instruct",
+    model_parameters={"max_new_tokens": 512},
+)
+
+agentic = AgenticSQLGenerationPipeline()
+agentic.run_pipeline(
+    benchmark_id="bird_mini_dev_sqlite",
+    model_name="wxai:ibm/granite-34b-code-instruct",
+    model_parameters={"max_new_tokens": 512},
+    max_attempts=3,
+)
+```
+
+See the docstrings of the exported functions/classes in `text2sql_eval_toolkit.__init__` for the full list of public APIs.
+
+### Running Experiments
+
+**Single Benchmark:**
+```bash
+python scripts/run_experiment.py [benchmark_name]
+```
+
+This will initialize a pipeline, perform inference to generate SQLs and output dataframes, and run the evaluation script to gather accuracy metrics. Benchmark names and configurations are defined in [`data/benchmarks.json`](data/benchmarks.json) (for full benchmarks) or [`data/test-benchmarks.json`](data/test-benchmarks.json) (for test benchmarks). See [data/benchmarks/README.md](data/benchmarks/README.md) for more details. Run `python scripts/run_experiment.py -h` for details on how to set different input arguments for the script.
+
+**Multiple Benchmarks:**
+```bash
+# Run all test benchmarks (recommended for quick validation)
+python scripts/run_all_benchmarks.py --test
+
+# Run all full benchmarks
+python scripts/run_all_benchmarks.py
+
+# Run with all baselines (standard + 6 agentic variants)
+python scripts/run_all_benchmarks.py --test --run_all_baselines
+```
+
+The `run_all_benchmarks.py` script supports separate model configurations for standard and agentic baselines to optimize runtime. See [data/benchmarks/README.md](data/benchmarks/README.md#model-configuration) for detailed configuration options.
+
+### Running Individual Components
+
+To run evaluation only:
+
+```
+python scripts/evaluation/run_evaluation.py [-h] [--output_file OUTPUT_FILE] [--summary_file SUMMARY_FILE] [--csv_summary_file CSV_SUMMARY_FILE] [--use_llm_judge] input_file
+```
+
+See [`scripts/evaluation/README.md`](scripts/evaluation/README.md) for details.
+
+To run inference only:
+
+```bash
+# Standard baseline inference
+python scripts/inference/run_inference.py benchmark_id [--model_names MODEL1 MODEL2 ...]
+
+# Agentic pipeline inference with default models
+python scripts/inference/run_inference.py benchmark_id --pipeline_type agentic
+
+# Agentic pipeline with custom models
+python scripts/inference/run_inference.py benchmark_id --pipeline_type agentic \
+  --agentic_models "wxai:openai/gpt-oss-120b" "wxai:meta-llama/llama-3-3-70b-instruct"
+
+# Additional options
+python scripts/inference/run_inference.py benchmark_id \
+  --pipeline_type agentic \
+  --agentic_version v2 \
+  --max_attempts 5 \
+  --max_new_tokens 1024
+```
+
+Like `run_experiment.py` and `run_all_benchmarks.py`, the inference script supports separate model configurations via `--model_names` (for standard baseline) and `--agentic_models` (for agentic pipeline). Run `python scripts/inference/run_inference.py -h` for all options.
+
+To run execution only:
+
+```
+python scripts/execution/run_execution.py [-h] benchmark_id
+```
+
+To produce the results dashboard along with results summary and error analysis Markdown files for all the benchmarks defined in the `data/benchmarks.json` file, run:
+
+```
+python scripts/analysis/make_summary_report.py
+```
+
+The output will be written to [data/results/README.md](data/results/README.md).
+
+## Project Structure
+
+```
+text2sql-eval-toolkit
+├── notebooks/                  # Jupyter notebooks showcasing the use of the toolkit functions
+├── data/                       # Benchmark datasets and evaluation results
+│   ├── benchmarks/             # Benchmark data and schema files
+│   │   ├── README.md           # Detailed benchmark documentation
+│   │   ├── test_benchmarks/    # Test benchmark data files
+│   │   └── dbs/                # Database files and setup instructions
+│   ├── benchmarks.json         # Full benchmarks configuration
+│   ├── test-benchmarks.json    # Test benchmarks configuration (smaller datasets)
+│   └── results/                # Evaluation outputs
+│           └── README.md       # Summary of results
+├── scripts/                    # Scripts for running experiments
+│   ├── analysis/               # Results and error analysis scripts and utilities
+│   ├── curation/               # Benchmark data curation and preprocessing scripts
+│   ├── evaluation/             # Evaluation pipeline script
+│   ├── execution/              # Scripts for SQL execution
+│   ├── inference/              # Inference pipeline (baseline) script
+│   ├── profiling/              # SQL query profiling script
+├── src/                        # Source code for the toolkit
+│   └── text2sql_eval_toolkit/  # Core modules
+│       ├── analysis/           # Results and error analysis module
+│       ├── evaluation/         # Evaluation module
+│       ├── execution/          # SQL execution module
+│       ├── inference/          # LLM inference (baseline) module
+│       └── profiling/          # SQL profiling module
+├── pyproject.toml              # Build system and project metadata
+├── README.md                   # Project documentation
+├── requirements.txt            # Python dependencies
+└── LICENSE                     # License file
+
+```
+
+## Contributing
+
+We welcome external contributions! If you have an itch, please feel free to scratch it.
+
+To contribute code or documentation, please submit a [pull request](https://github.com/IBM/text2sql-eval-toolkit/pulls).
+
+A good way to familiarize yourself with the codebase and contribution process is to look for and tackle low-hanging fruit in the [issue tracker](https://github.com/IBM/text2sql-eval-toolkit/issues).
+
+**Note: We appreciate your effort, and want to avoid a situation where a contribution requires extensive rework (by you or by us), sits in backlog for a long time, or cannot be accepted at all!**
+
+For detailed contribution guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+### Pull Request Process
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for more details.
+
+## Additional Resources
+
+- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - Community guidelines
+- [SECURITY.md](SECURITY.md) - Security policy and vulnerability reporting
+- [MAINTAINERS.md](MAINTAINERS.md) - Project maintainers
+- [CHANGELOG.md](CHANGELOG.md) - Project changelog
+
+[issues]: https://github.com/IBM/text2sql-eval-toolkit/issues/new