semantic_parsing_with_constrained_lm/README.md

Semantic Parsing with Constrained Language Models

This repository contains tools and instructions for reproducing the experiments in the following papers:

1. Constrained Language Models Yield Few-Shot Semantic Parsers (EMNLP 2021).

   @inproceedings{ConstrainedLMSemanticParser2021,
       title = "Constrained Language Models Yield Few-Shot Semantic Parsers",
       author = "Shin, Richard and Lin, Christopher H. and Thomson, Sam and Chen, Charles and Roy, Subhro and Platanios,  Emmanouil Antonios and Pauls, Adam and Klein, Dan and Eisner, Jason and Van Durme, Benjamin",
       booktitle = "Proceedings of the 2021 Conference on Empirical Methods in Natural Language Processing",
       year = "2021",
       publisher = "Association for Computational Linguistics",
   }
   

2. BenchCLAMP: A Benchmark for Evaluating Language Models on Semantic Parsing

   @misc{BenchCLAMP2022,
       doi = {10.48550/ARXIV.2206.10668},
       url = {https://arxiv.org/abs/2206.10668},
       author = {Roy, Subhro and Thomson, Sam and Chen, Tongfei and Shin, Richard and Pauls, Adam and Eisner, Jason and Van Durme, Benjamin},
       title = {{BenchCLAMP}: A Benchmark for Evaluating Language Models on Semantic Parsing},
       publisher = {arXiv},
       year = {2022},
   }
   

If you use any source code or data included in this toolkit in your work, please cite the relevant paper.

Initial set-up

• Install Poetry: https://python-poetry.org/docs/#installation.
• Install Python 3.7, which is the version of Python that has been used for developing this repository.
• Install pipx so that we can install command-line dependencies: https://pypa.github.io/pipx/.

First, check that we are not unintentionally in a virtualenv. Run poetry env info; under "Virtualenv", it should show Path: NA. If it displays the path to an existing virtualenv, deactivate it, for example by running deactivate or conda deactivate.

Then run the following to set up the package:

cd semantic_parsing_with_constrained_lm
poetry config virtualenvs.in-project true --local
poetry env use <path to python3.7>
poetry install
poetry shell

Before running any of the commands below, run poetry shell to activate the virtualenv where all packages have been installed. You can exit to deactivate the virtualenv.

To run any experiments with GPT-3, you will need to obtain an API key from OpenAI at https://beta.openai.com/ and set an environment variable.

export OPENAI_API_KEY=<your API key>

The GPT-3 experiments use the "davinci" engine by default. You can use a different engine by setting the OPENAI_GPT3_ENGINE environment variable.

To reproduce experiments from EMNLP 2021 paper, please follow README_EMNLP_2021.md.

To use BenchCLAMP, please follow README_BenchCLAMP.md.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.