setlexsem 0.0.1

No project description provided

Overview

This research repository maintains the code and the results for the research paper: SETLEXSEM CHALLENGE: Using Set Operations to Evaluate the Lexical and Semantic Robustness of Language Models.

"Set theory has become the standard foundation for mathematics, as every mathematical object can be viewed as a set." -Stanford Encyclopedia of Philosophy

Install

When installing, it's important to upgrade to the most recent pip. This ensures that setup.py runs correctly. An outdated version of pip can fail to run the InstallNltkWordnetAfterPackages command class in setup.py and cause subsequent errors.

/usr/bin/python3 -mvenv venv
. venv/bin/activate
python3 -m pip install --upgrade pip
pip install -e .
pip install -e ."[dev, test]"

NLTK words

If you get errors from nltk about package words not being installed while executing the code in this repository, run:

import nltk
nltk.download("words")

Note that words should be automatically installed by pip when you follow the installation instructions for this package.

Directory Structure

• configs/
  • configs/experimetns contains configuration files which specify hyperparamter settings for running experiments.
  • configs/generation_data contains configuration files for dataset generation
  • configs/generation_prompt contains configuration files for prompt generation based on the data previously stored
  • configs/post_analysis contains a configuration file which can be used for analysis of cost, latency, and performance metrics for one set of hyperparameters for a particular study. This config is used in the script scripts/anaylsis_for_one_study.py
  • configs/post_hypothesis contains a configuration file which specifies filtering criterias for generating figures for various hypotheses.
• notebooks/ has a Jupyter notebook for generating figures that are used in the research paper
• scripts/ contains Python scripts for running experiments, post-processing the results, and analysis of results
• setlexsem/ is the module which has all the important functions and utils for analysis, experimentation, generation of data, samplers.
  • analyze contains code for error_analysis of post-processed results, visualizaiton code and utils neeeded for generating figures for hypothesis.
  • experiment contains code for invoking LLMs and running experiments for a particular hypothesis/study.
  • generate contains code for generating data, sample synthetic sets, prompts and utils needed for data generation.
  • prepare contains helper functions for partitioning words according to their frequencies.

Generating Datasets

Generate Sets with Numbers or Words

To generate your own data, you can run the following:

python setlexsem/generate/generate_data.py --config_path "configs/generation_data/numbers_and_words.yaml" --seed_value 292 --save_data 1

Generate Sets based on their training-set frequency

To generate sets based on their training-set frequency, we use an approximation based on rank frequency in the Google Books Ngrams corpus.

This requires wget (brew install wget or apt install wget). After installing wget, you need to create deciles.json. The following command downloads the English unigram term frequencies of the Google Books Ngram corpus, filters them by the vocabulary of the nltk.words English vocabulary, and stores the vocabulary, separated by deciles of rank frequency, in data/deciles.json.

scripts/make-deciles.sh

This will take ~10 minutes or more, depending on your bandwidth and the speed of your computer.

Then run the following to generate data.

python setlexsem/generate/generate_data.py --config_path "configs/generation_data/deciles.yaml" --seed_value 292 --save_data 1

Generating Prompts

Example: Sets with Numbers

To generate your own data, you can run the following:

python setlexsem/generate/generate_prompts.py --config_path "configs/generation_prompt/test_config.yaml" --seed_value 292 --save_data 1

Running Experiments End-to-End

1. Create a config file like configs/experiments/anthr_sonnet.yaml
2. Run the experiment:

python setlexsem/experiment/run_experiments.py --account_number <account-number> --save_file 1 --load_last_run 1 --config_file configs/experiments/anthr_sonnet.yaml

Note: Currently, our experiments are dependent on AWS Bedrock and need an AWS account number to be provided. However, you have the capability to run experiments using OPENAI_KEY. We will add more instructions soon.

3. Post-Processing results (Check whether your study_name is present in the STUDY2MODEL dict in setlexsem/constants.py)

python scripts/save_processed_results_for_study_list.py

4, Analysis of cost, latency, and performance metrics for one set of hyperparameters for a particular study - enter hyperparameter values in the configs/post_analysis/study_config.json

python scripts/analysis_for_one_study.py

• Generate figures using notebooks/Hypothesis Testing - Manuscript.ipynb. Validate the filtering criterias in configs/post_hypothesis/hypothesis.json

Test

To test the full-suite of tests, you need to provide the Account Number.

pytest -s .

You will be prompted to provide your Account Number after that.

Coverage Report

pip install pytest-cov
pytest --cov=setlexsem --cov-report=term-missing

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.