Skip to content

Commit

Permalink
Reformat docs
Browse files Browse the repository at this point in the history
  • Loading branch information
steventkrawczyk committed Jul 17, 2023
1 parent c0f131d commit 0326f37
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,52 +10,52 @@ Welcome to PromptTools!
:maxdepth: 2
:caption: Contents:

Welcome to `prompttools` created by [Hegel AI](https://hegel-ai.com/)!
Welcome to ``prompttools`` created by `Hegel AI<https://hegel-ai.com/>`!
This repo offers a set of free, open-source tools for testing and experimenting with prompts.
The core idea is to enable developers to evaluate prompts using familiar interfaces
like _code_ and _notebooks_.
like *code* and *notebooks*.


To stay in touch with us about issues and future updates,
join the [Discord](https://discord.gg/7KeRPNHGdJ).
join the `Discord<https://discord.gg/7KeRPNHGdJ>`_.


Quickstart
==================

To install `prompttools`, you can use `pip`:
To install ``prompttools``, you can use ``pip``:

```
``
pip install prompttools
```
``

You can run a simple example of a `prompttools` with the following
You can run a simple example of a ``prompttools`` with the following

```
``
DEBUG=1 python examples/prompttests/example.py
```
``

To run the example outside of `DEBUG` mode, you'll need to bring your own OpenAI API key.
This is because `prompttools` makes a call to OpenAI from your machine. For example:
To run the example outside of ``DEBUG`` mode, you'll need to bring your own OpenAI API key.
This is because ``prompttools`` makes a call to OpenAI from your machine. For example:

```
``
OPENAI_API_KEY=sk-... python examples/prompttests/example.py
```
``

You can see the full example [here](https://github.com/hegelai/prompttools/tree/main/examples/prompttests/test_openai_chat.py).
You can see the full example `here<https://github.com/hegelai/prompttools/tree/main/examples/prompttests/test_openai_chat.py>`_.

Using `prompttools`
Using ``prompttools``
==================

There are primarily two ways you can use `prompttools` in your LLM workflow:
There are primarily two ways you can use ``prompttools`` in your LLM workflow:

1. Run experiments in [notebooks](https://github.com/hegelai/prompttools/tree/main/examples/notebooks/).
1. Write [unit tests](https://github.com/hegelai/prompttools/tree/main/examples/prompttests/test_openai_chat.py) and integrate them into your CI/CD workflow [via Github Actions](/.github/workflows/post-commit.yaml).
1. Run experiments in `notebooks<https://github.com/hegelai/prompttools/tree/main/examples/notebooks/>`_.
1. Write `unit tests<https://github.com/hegelai/prompttools/tree/main/examples/prompttests/test_openai_chat.py>`_``
and integrate them into your CI/CD workflow `via Github Actions<https://github.com/hegelai/prompttools/tree/main/.github/workflows/post-commit.yaml>`_.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

0 comments on commit 0326f37

Please sign in to comment.