Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shreyashankar committed Sep 17, 2024
1 parent a2d0d34 commit 9f42e25
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 9 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

DocETL is a powerful tool for creating and executing data processing pipelines, especially suited for complex document processing tasks. It offers a low-code, declarative YAML interface to define complex data operations on complex data.

[Documentation](https://shreyashankar.github.io/docetl) | [Website](https://docetl.com)
[Website](https://docetl.com) | [Documentation](https://shreyashankar.github.io/docetl) | [Discord](https://discord.gg/fHp7B2X3xx)

## When to Use DocETL

Expand All @@ -23,13 +23,15 @@ DocETL is the ideal choice when you're looking to maximize correctness and outpu

## Installation

See the documentation for installing from PyPI.

### Prerequisites

Before installing DocETL, ensure you have Python 3.10 or later installed on your system. You can check your Python version by running:

python --version

### Installation Steps
### Installation Steps (from Source)

1. Clone the DocETL repository:

Expand Down Expand Up @@ -60,7 +62,7 @@ OPENAI_API_KEY=your_api_key_here

Alternatively, you can set the OPENAI_API_KEY environment variable in your shell.

5. Run the basic test suite to ensure everything is working:
5. Run the basic test suite to ensure everything is working (this costs less than $0.01 with OpenAI):

```bash
make tests-basic
Expand Down
1 change: 1 addition & 0 deletions docs/community/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ mindmap

- **Model Diversity**: Extending support beyond OpenAI to include a wider range of models, with a focus on local models.
- **OCR and PDF Extraction**: Improving integration with OCR technologies and PDF extraction tools for more robust document processing.
- **Multimodal Data Processing**: Enhancing DocETL to handle multimodal data, including text, images, audio, and video (as many of the LLMs support multimodal inputs, anyways).

## Agents and Planning

Expand Down
22 changes: 16 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ python --version
pip install docetl
```

This command will install DocETL along with its dependencies as specified in the pyproject.toml file.
This command will install DocETL along with its dependencies as specified in the pyproject.toml file. To verify that DocETL has been installed correctly, you can run the following command in your terminal:

```bash
docetl version
```

## Installation from Source

Expand All @@ -45,15 +49,21 @@ poetry install

This will create a virtual environment and install all the required dependencies.

## Verifying the Installation
4. Set up your OpenAI API key:

To verify that DocETL has been installed correctly, you can run the following command in your terminal:
Create a .env file in the project root and add your OpenAI API key:

```bash
docetl version
OPENAI_API_KEY=your_api_key_here
```

If the installation was successful, this command will display the version of DocETL installed on your system.
Alternatively, you can set the OPENAI_API_KEY environment variable in your shell.

5. Run the basic test suite to ensure everything is working (this costs less than $0.01 with OpenAI):

```bash
make tests-basic
```

## Troubleshooting

Expand All @@ -63,4 +73,4 @@ If you encounter any issues during installation, please ensure that:
- You have the latest version of pip installed
- Your system meets all the requirements specified in the pyproject.toml file

For further assistance, please refer to the project's GitHub repository or reach out to the community for support.
For further assistance, please refer to the project's GitHub repository or reach out on the [Discord server](https://discord.gg/fHp7B2X3xx).

0 comments on commit 9f42e25

Please sign in to comment.