Skip to content

Commit 8bfc1fb

Browse files
authored
Move installation section of readme higher. (#8)
1 parent 71f075d commit 8bfc1fb

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
Joinly is a library designed join two different lists of keyed values using a large language model (LLM). Like a human data annotator, you can provide context through a prompt to specify how you want the task accomplished. The library supports inner, left, right, and full joins.
44

5-
By default, the library uses OpenAI's GPT-4o model. To use the library, set your OpenAI credentials as follows:
5+
# Installation
6+
7+
Install Joinly using pip:
68

79
```
8-
OPENAI_API_KEY=XXXX
10+
pip install joinly
911
```
1012

1113
# Format
@@ -23,14 +25,6 @@ right: List[Tuple[str, Any]] = []
2325
results: List[Tuple[Tuple[str, Any], Tuple[str, Any]]] = join.inner_join(left, right)
2426
```
2527

26-
# Installation
27-
28-
Install Joinly using pip:
29-
30-
```
31-
pip install joinly
32-
```
33-
3428
# Quickstart
3529

3630
Suppose you have two lists of fruits. One is more specific about the types of fruits, while the other is more general. Joinly allows you to describe the task and join the lists in a fuzzy manner using LLMs.
@@ -64,6 +58,12 @@ results = join.inner_join(left, right, context=context)
6458
]
6559
```
6660

61+
By default, the library uses OpenAI's GPT-4o model. To use the library, set your OpenAI credentials as follows:
62+
63+
```
64+
OPENAI_API_KEY=XXXX
65+
```
66+
6767
# Custom LLMs
6868

6969
You can integrate any custom model by implementing the `BaseAI` class with an embedding method and a prompt.

0 commit comments

Comments
 (0)