Skip to main content

Interactive Composition Explorer

Project description

Interactive Composition Explorer 🧊

ICE is a Python library and trace visualizer for language model programs.

Screenshot

ice-screenshot Execution trace visualized in ICE

Features

  • Run language model recipes in different modes: humans, human+LM, LM
  • Inspect the execution traces in your browser for debugging
  • Define and use new language model agents, e.g. chain-of-thought agents
  • Run recipes quickly by parallelizing language model calls
  • Reuse component recipes such as question-answering, ranking, and verification

ICE is pre-1.0

:warning: The ICE API may change at any point. The ICE interface is being actively developed and we may change the API at any point, including removing functionality, renaming methods, splitting ICE into multiple projects, and other similarly disruptive changes. Use at your own risk.

Getting started

  1. Install ICE:

    pip install ought-ice
    
  2. Set required secrets in ~/.ought-ice/.env. See .env.example for the format.

  3. Start ICE in its own terminal and leave it running:

    python -m ice.server
    
  4. To learn more, go through the Primer.

Terminology

  • Recipes are decompositions of a task into subtasks.

    The meaning of a recipe is: If a human executed these steps and did a good job at each workspace in isolation, the overall answer would be good. This decomposition may be informed by what we think ML can do at this point, but the recipe itself (as an abstraction) doesn’t know about specific agents.

  • Agents perform atomic subtasks of predefined shapes, like completion, scoring, or classification.

    Agents don't know which recipe is calling them. Agents don’t maintain state between subtasks. Agents generally try to complete all subtasks they're asked to complete (however badly), but some will not have implementations for certain task types.

  • The mode in which a recipe runs is a global setting that can affect every agent call. For instance, whether to use humans or agents. Recipes can also run with certain RecipeSettings, which can map a task type to a specific agent_name, which can modify which agent is used for that specfic type of task.

Additional resources

  1. Join the ICE Slack channel to collaborate with other people composing language model tasks. You can also use it to ask questions about using ICE.

  2. Watch the recording of Ought's Lab Meeting to understand the high-level goals for ICE, how it interacts with Ought's other work, and how it contributes to alignment research.

  3. Read the ICE announcement post for another introduction.

Contributions

ICE is an open-source project by Ought. We're an applied ML lab building the AI research assistant Elicit.

We welcome community contributions:

  • If you're a developer, you can dive into the codebase and help us fix bugs, improve code quality and performance, or add new features.
  • If you're a language model researcher, you can help us add new agents or improve existing ones, and refine or create new recipes and recipe components.

For larger contributions, make an issue for discussion before submitting a PR.

And for even larger contributions, join us - we're hiring!

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

ought-ice-0.3.2.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

ought_ice-0.3.2-py3-none-any.whl (645.5 kB view details)

Uploaded Python 3

File details

Details for the file ought-ice-0.3.2.tar.gz.

File metadata

  • Download URL: ought-ice-0.3.2.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for ought-ice-0.3.2.tar.gz
Algorithm Hash digest
SHA256 0bf1a266c9bb0de996971024c34fe693965048c8d92cf22a0ed70da6abccdfa6
MD5 6843593fb8e86bb70c05fe282cf09584
BLAKE2b-256 3658ac69eb245f29750778aace278bfacd43ca1f0a38c6c7832881ece8c4c8ca

See more details on using hashes here.

File details

Details for the file ought_ice-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: ought_ice-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 645.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.4

File hashes

Hashes for ought_ice-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 88048c381e2fd04fd71dbf06771c5c523d6b7a690941aa96facd4d2d9951a6af
MD5 524027617f2198b64006885967ce7567
BLAKE2b-256 4e3bd8454815e6f96e5c7ca0b7c9b65ac9d763b7e907c147f8244d4ba4042875

See more details on using hashes here.

Supported by

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