Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

Experiments

This directory contains experimental code that is offered as-is and should be treated as experimental components, not part of the core tau2 benchmark.

⚠️ Important: The code in this directory is experimental and may not be fully tested or supported. Use at your own discretion.

Overview

The experiments/ folder is used for experimental features and research code that extends beyond the core tau2 benchmark. It can be used for new features, prototypes, and innovative approaches that are not part of the core evaluation framework. These components are provided for research purposes and to enable advanced use cases.

Directory Structure

This directory is organized into subdirectories for different types of experimental components. Each subdirectory should contain its own README with specific documentation and usage instructions.

Quick Start

To contribute experimental code:

  1. Create a new subdirectory for your experiment
  2. Add a comprehensive README.md explaining the purpose and usage
  3. Include example scripts and basic tests
  4. Follow the development guidelines below

Development Guidelines

When working with experimental code:

  1. Backward Compatibility: Maintain compatibility with core tau2 interfaces when possible
  2. Documentation: Each experimental component should have its own README
  3. Testing: Include basic testing scripts and examples
  4. Dependencies: Manage dependencies carefully to avoid conflicts with core tau2
  5. Isolation: Keep experimental code self-contained within this directory

Contributing

Experimental contributions are welcome! Please:

  1. Add comprehensive documentation in your subfolder's README
  2. Include example usage and test scripts
  3. Mark any breaking changes or dependencies clearly
  4. Consider the experimental nature - code doesn't need to be production-ready

Support

Since this is experimental code:

  • No guarantees of stability or continued support
  • Community-driven - contributions and improvements welcome
  • Use at your own risk - test thoroughly before production use
  • Documentation-first - refer to individual README files for detailed usage

For core tau2 benchmark support, see the main project documentation.