Skip to content

Commit

Permalink
Fix a typo in experiment.rst (#91)
Browse files Browse the repository at this point in the history
* Fix a typo in experiment.rst

* Escape the trailing space
  • Loading branch information
bweber-rebellion authored Sep 25, 2023
1 parent 922b532 commit 3845245
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/experiment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ Experiment
There are two main abstractions used in the ``prompttools`` library: Experiments and Harnesses.
Occasionally, you may want to use a harness, because it abstracts away more details.

An experiment is a low level abstraction that takes the cartesian product of possible inputs to
An experiment is a low level abstraction that takes the Cartesian product of possible inputs to
an LLM API. For example, the ``OpenAIChatExperiment`` accepts lists of inputs for each parameter
of the OpenAI Chat Completion API. Then, it constructs and asynchronously executes requests
using those potential inputs. An example of using experiment is `here <https://github.com/hegelai/prompttools/blob/main/examples/notebooks/BasicExperiment.ipynb>`_.

There are two ways to initialize an experiment:

1. Wrap your parameters in ``list``s and pass them into the ``__init__`` method. See each class's
1. Wrap your parameters in ``list``\ s and pass them into the ``__init__`` method. See each class's
method signature in the "Integrated Experiment APIs" section for details.
2. Define which parameters should be tested and which ones should be frozen in two dictionaries. Pass the
dictionaries to the ``initialize`` method. See the ``classmethod initialize`` below for details.
Expand Down

0 comments on commit 3845245

Please sign in to comment.