From a47f8e40fcc59fd3896fbd446e9e217be1e6b772 Mon Sep 17 00:00:00 2001 From: Emmett McFaralne Date: Sat, 13 Apr 2024 18:04:55 -0400 Subject: [PATCH] readme doc fixes --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6ac3246..8976a93 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Pipeline Illustration The Pipe -[![codecov](https://codecov.io/gh/emcf/thepipe/graph/badge.svg?token=OE7CUEFUL9)](https://codecov.io/gh/emcf/thepipe) ![python-gh-action](https://github.com/emcf/thepipe/actions/workflows/python-ci.yml/badge.svg) ![Website](https://img.shields.io/website?url=https%3A%2F%2Fthepipe.up.railway.app%2F&label=API%20status) ![get API](https://img.shields.io/badge/API-Apply%20here-blue) +[![codecov](https://codecov.io/gh/emcf/thepipe/graph/badge.svg?token=OE7CUEFUL9)](https://codecov.io/gh/emcf/thepipe) ![python-gh-action](https://github.com/emcf/thepipe/actions/workflows/python-ci.yml/badge.svg) ![Website](https://img.shields.io/website?url=https%3A%2F%2Fthepipe.up.railway.app%2F&label=API%20status) ![get API](https://img.shields.io/badge/API-get%20access-blue) ### Prepare PDFs, word docs, slides, web pages and more for Vision-LLMs with one line of code ⚡ -The Pipe is a multimodal-first tool for feeding files and web pages into vision language models like GPT-4V, Gemini Pro, and LLaVa. It is best for LLM and RAG applications that require a deep understanding of complex sources. The Pipe is available as a hosted API at [thepi.pe](https://thepi.pe) and as a standalone tool you can use locally. +The Pipe is a multimodal-first tool for feeding files and web pages into vision language models like GPT-4V, Gemini Pro, and LLaVa. It is best for LLM and RAG applications that require a deep understanding of complex sources. The Pipe is available as a hosted API at [thepi.pe](https://thepi.pe), or it can be set up locally. ## Getting Started 🚀 @@ -12,7 +12,7 @@ First, install The Pipe. pip install thepipe_api ``` -Ensure the `THEPIPE_API_KEY` environment variable is set. Don't have an API key yet? [Get one here](https://thepi.pe). Looking to host it locally? See the [local installation](#local-installation) section. +Ensure the `THEPIPE_API_KEY` environment variable is set. Don't have an API key yet? [Get one here](https://thepi.pe). Looking to host it yourself locally instead? See the [local installation](#local-installation) section at the bottom. Now you can extract comprehensive text and visuals from any file: ```python @@ -63,8 +63,6 @@ The pipe is accessible from the command line or from [Python](https://www.python | GitHub Repository | GitHub repo URLs | ✔️ | ✔️ | Extracts from GitHub repositories; supports branch specification | | ZIP File | `.zip` | ✔️ | ✔️ | Extracts contents of ZIP files; supports nested directory extraction | -## Installation 📦 - ## Local Installation 🛠️ To use The Pipe locally, you will need [playwright](https://github.com/microsoft/playwright), [ctags](https://github.com/universal-ctags/), [pytesseract](https://github.com/h/pytesseract), and the local python requirements, which differ from the more lightweight API requirements. You will also need to use the local version of the requirements file: