Skip to main content

Toolkit for Active Learning in Generative Tasks

Project description

ATGen: Active Learning for Natural Language Generation

License: MIT

A comprehensive toolkit for applying active learning techniques to natural language generation tasks. This repository contains implementations of various active learning strategies specifically designed for text generation models, helping to reduce annotation costs while maximizing model performance.

🌟 Features

  • Multiple Active Learning Strategies: Implementation of strategies like HUDS, HADAS, FAC-LOC, IDDS, and more
  • Flexible Model Support: Compatible with various language models (Qwen, Llama, etc.)
  • Comprehensive Evaluation: Supports multiple evaluation metrics including ROUGE, BLEU, BERTScore, AlignScore, etc.
  • Interactive Visualization: Streamlit dashboard for exploring results and comparing strategies
  • Hydra Configuration: Easily configurable experiments through Hydra's YAML-based configuration system
  • PEFT Integration: Efficient fine-tuning using Parameter-Efficient Fine-Tuning methods

📋 Requirements

  • Python 3.10+
  • CUDA-compatible GPU (for model training)
  • Dependencies listed in requirements.txt

🔧 Installation

  1. Clone the repository:

    git clone https://github.com/Aktsvigun/atgen.git
    cd atgen
    
  2. Run the installation script:

    bash install.sh
    

    This will install:

    • All required Python packages
    • External metrics (submodlib, AlignScore)
    • Required NLP resources

🚀 Usage

Running Active Learning Experiments

Experiments can be launched using the run-al command:

CUDA_VISIBLE_DEVICES=0 HYDRA_CONFIG_NAME=base run-al

Parameters:

  • CUDA_VISIBLE_DEVICES: Specify which GPU to use
  • HYDRA_CONFIG_NAME: Configuration file (e.g., base, custom, test)

Additional parameters can be overridden via the command line following Hydra's syntax:

CUDA_VISIBLE_DEVICES=0 HYDRA_CONFIG_NAME=base run-al al.strategy=huds model.checkpoint=Qwen/Qwen2.5-7B

Interactive Dashboard

Launch the Streamlit application to explore and visualize your experiments:

streamlit run Welcome.py

Navigate to http://localhost:8501 in your web browser to access the dashboard.

📁 Project Structure

  • configs/: Configuration files for experiments
    • al/: Active learning strategy configurations
    • data/: Dataset configurations
    • labeller/: Labeller configurations
  • src/atgen/: Main package
    • strategies/: Implementation of active learning strategies
    • metrics/: Code for evaluation metrics
    • utils/: Utility functions
    • run_scripts/: Scripts for running experiments
    • labellers/: Labelling mechanisms
    • visualize/: Visualization tools
  • pages/: Streamlit application pages
  • outputs/: Experimental results storage
  • cache/: Cached computations to speed up repeated runs

📚 Supported Active Learning Strategies

  • huds: Hypothetical Document Scoring
  • hadas: Harmonic Diversity Scoring
  • random: Random sampling baseline
  • fac-loc: Facility Location strategy
  • idds: Improved Diverse Density Scoring
  • And more...

📊 Supported Datasets

The toolkit comes pre-configured for several datasets including summarization, question answering, and other generative tasks. Custom datasets can be added by creating new configuration files.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📜 License

This project is licensed under the MIT License - see the LICENSE.md file for details.

🔗 Citation

If you use this toolkit in your research, please cite:

@software{atgen,
  title = {ATGen: Active Learning for Natural Language Generation},
  url = {https://github.com/Aktsvigun/atgen},
  year = {2025},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atgen-0.0.1.dev2.tar.gz (56.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

atgen-0.0.1.dev2-py3-none-any.whl (74.2 kB view details)

Uploaded Python 3

File details

Details for the file atgen-0.0.1.dev2.tar.gz.

File metadata

  • Download URL: atgen-0.0.1.dev2.tar.gz
  • Upload date:
  • Size: 56.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for atgen-0.0.1.dev2.tar.gz
Algorithm Hash digest
SHA256 40573dd25d73f55754944650b59def742cb73f95afc11e52e5f8e47165b3098b
MD5 a42c9784a5a0674a637c3e77c4f5789c
BLAKE2b-256 acd79a7cc092d7436a266bb279524bb074f58eba703cfd9b23d20ce8889bb716

See more details on using hashes here.

File details

Details for the file atgen-0.0.1.dev2-py3-none-any.whl.

File metadata

  • Download URL: atgen-0.0.1.dev2-py3-none-any.whl
  • Upload date:
  • Size: 74.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for atgen-0.0.1.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 1185e42eaa3a8fc1943c97dd8f989b02178a27aa1b7a8849144a9412ea2e2422
MD5 8677c64380ccde5bd54e6721498613f2
BLAKE2b-256 dd31897e894a884300694a2531025b0a421611e82ef27e265d3e53d22810282a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page