Skip to content

Commit 7e1ae29

Browse files
committed
Docs update
1 parent f59fa1f commit 7e1ae29

2 files changed

Lines changed: 2 additions & 14 deletions

File tree

docs/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# python-llms-wrapper
22

3-
**IMPORTANT** This is still work in progress! API may change and documentation is still work in progress!
4-
53
The `llms_wrapper` Python package is an opinionated library based on the excellent
64
[`litelmm`](https://github.com/BerriAI/litellm) package to simplify using diverse
75
LLMs from many different providers.

docs/installation.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,5 @@
11
# Installation
22

3-
### 1. Python environment
43

5-
* If necessary create a new python environment
6-
* e.g. using Ana/Miniconda: `conda create -y -n llms_wrapper python=3.11`
7-
8-
### 2. Install package
9-
10-
* From local source:
11-
* clone the repository and change into the directory
12-
* run `pip install -e .`
13-
* To install for development: `python -m pip install -e .[dev]`
14-
* From source directly from github: `pip install -U git+https://github.com/OFAI/python-llms-wrapper.git`
15-
* To create a notebook kernel run `python -m ipykernel install --user --name=llms_wrapper`
4+
* Use `pip install` or `uv pip install` to directly install from the github repo using the package name `git+https://github.com/OFAI/python-llms-wrapper.git`
5+
* e.g. `pip install -U git+https://github.com/OFAI/python-llms-wrapper.git`

0 commit comments

Comments
 (0)