Skip to main content

AI-powered target variable creation and synthesis agent

Project description

Target Synthesis Agent

An intelligent AI-powered agent for generating and synthesizing target variables for machine learning tasks. This tool analyzes data characteristics and business context to create optimal target variables for various ML applications.

🚀 Features

  • AI-Powered Analysis: Leverages advanced LLM models to analyze data and business context
  • Multiple Data Sources: Works with both SQL databases and pandas DataFrames
  • Customizable Workflows: Supports various ML approaches and synthesis strategies
  • Comprehensive Testing: Includes a complete test suite for reliability
  • Extensible Architecture: Easy to extend with custom components and integrations

📦 Installation

Prerequisites

  • Python 3.10+
  • Git
  • uv package manager (recommended)

Setup

  1. Clone the repository

    git clone https://github.com/stepfnAI/target_synthesis_agent.git
    cd target_synthesis_agent/
    git checkout review
    
  2. Set up the virtual environment and install dependencies

    uv venv --python=3.10 venv
    source venv/bin/activate
    uv pip install -e ".[dev]"
    
  3. Clone and install the blueprint dependency

    cd ..
    git clone https://github.com/stepfnAI/sfn_blueprint.git
    cd sfn_blueprint
    git switch dev
    uv pip install -e .
    cd ../target_synthesis_agent
    
  4. Set up environment variables

    # Optional: Configure LLM provider (default: openai)
    export LLM_PROVIDER="your_llm_provider"
    
    # Optional: Configure LLM model (default: gpt-4)
    export LLM_MODEL="your_llm_model"
    
    # Required: Your LLM API key
    export LLM_API_KEY="your_llm_api_key"
    

🛠️ Usage

Basic SQL Usage

python examples/sql_basic_usage.py

🧪 Testing

Run the complete test suite:

pytest tests/ -s

Or run individual test files:

pytest tests/conftest.py -s
pytest tests/test_agent.py -s
pytest tests/test_utils.py -s

🏗️ Architecture

The Target Synthesis Agent is built with a modular architecture:

  • Core Components:

    • agent.py: Main SQL-based implementation
    • models.py: Data models and schemas
    • utils.py: Utility functions and helpers
    • constants.py: Configuration and prompts
  • Dependencies:

    • sfn-blueprint: Core framework and utilities
    • pandas: Data manipulation
    • sqlalchemy: Database interactions
    • scikit-learn: ML utilities

🤝 Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

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

📧 Contact

For questions or support, please contact support@stepfunction.ai

🙏 Acknowledgments

  • Built with ❤️ by StepFunction AI
  • Uses sfn-blueprint for core functionality
  • Inspired by modern MLOps best practices

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

target_synthesis_agent-1.0.5.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

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

target_synthesis_agent-1.0.5-py3-none-any.whl (24.7 kB view details)

Uploaded Python 3

File details

Details for the file target_synthesis_agent-1.0.5.tar.gz.

File metadata

File hashes

Hashes for target_synthesis_agent-1.0.5.tar.gz
Algorithm Hash digest
SHA256 dd0fc621b4fe19ac3c4a362faa015bf9c611fd7dffbde7b0d004ee0d9bebccbc
MD5 7791b1fd4c24e4e2a40145137bb076ea
BLAKE2b-256 8bf65cd351fb7451c7604e3e7d284edc0f3afda0d815db72554ee7b0bb267d04

See more details on using hashes here.

File details

Details for the file target_synthesis_agent-1.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for target_synthesis_agent-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 52c0af93814b39807c0a01e578fb73dc4e0c7269fa70778899c5f984235eb51b
MD5 d9bb10edcaf4e70f825796af202d2942
BLAKE2b-256 5663eb4099a3d4921b6808ee7a1c316b0f9d1b18ebdf9316ec6df167f48491de

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