Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,33 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: mit
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: mit
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
---
|
| 6 |
+
# AgLab LLM Wrapper
|
| 7 |
+
|
| 8 |
+
This is a simple Python wrapper around a custom AI model, encapsulated in the `AgLab` class. It allows you to set a system prompt and query the model using natural language.
|
| 9 |
+
|
| 10 |
+
## Features
|
| 11 |
+
|
| 12 |
+
- Easily set a system prompt to guide the model's behavior.
|
| 13 |
+
- Send user prompts to the model and receive responses as text.
|
| 14 |
+
- Encapsulates the logic for initializing and interacting with `AIModel`.
|
| 15 |
+
|
| 16 |
+
## Usage
|
| 17 |
+
|
| 18 |
+
```python
|
| 19 |
+
import aglab
|
| 20 |
+
|
| 21 |
+
lab = aglab.AgLab("Your name is ag lab llm. You are a helpful assistant.")
|
| 22 |
+
print(lab.AskAgLabLLM("What is the capital of France, also what is your name?"))
|
| 23 |
+
```
|
| 24 |
+
|
| 25 |
+
## Example Output
|
| 26 |
+
|
| 27 |
+
```
|
| 28 |
+
The capital of France is Paris. My name is ag lab llm.
|
| 29 |
+
```
|
| 30 |
+
|
| 31 |
+
## License
|
| 32 |
+
|
| 33 |
+
MIT License
|