Readme change.

Browse Source
This commit is contained in:
retoor 2025-01-20 04:43:43 +01:00
parent 6132970d59
commit 61d59817b5
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -13,6 +13,8 @@ With all this technology together you could create a Replika bot for example wit
It's as easy as it gets. But if you need help: retoor@molodetz.nl. Normally respond within a day.
---
## Example usage
```python
@ -28,15 +30,19 @@ harry.communicate("What did you just say to me?")
# It is able to remember variables and previous messages. You can teach it to do anything.
```
---
## Configuration
It requires an `OpenAI API key`. You can get it from [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys).
Configure the environment variable `OPENAI_API_KEY` with your API key in your `bashrc`.
It's also possible to give `api_key` as parameter to the initiation of the `ragent.Agent` class like this: `ragent.Agent(api_key="YOUR_API_KEY")`.
---
## Discussion
This is example output of the `python -m ragent.demo_discuss`.
<blockquote>
**Hermione**: Hello! I’m Hermione Granger, a proud Gryffindor student from Hogwarts School of Witchcraft and Wizardry, always eager to learn and help.
**Draco**: I'm Draco Malfoy, and it's rather unfortunate to see you here, isn't it?
**Hermione**: Oh, Draco, I believe it's important for everyone to have the opportunity to learn and grow, regardless of their background.
@ -45,11 +51,12 @@ This is example output of the `python -m ragent.demo_discuss`.
**Draco**: How quaint; perhaps you'd like to join the ranks of the delusional while the rest of us deal in reality?
**Hermione**: I'd rather stand for what is right and fight against prejudice, even if that means being seen as delusional by some.
**Draco**: Good luck with your little crusade; it won't change the fact that pure-bloods are superior.
</blockquote>
---
## Replika
This is example output of the `python -m ragent.demo_replika`. It is interactive, you have to type yourself with a Replika named `Katya`. It has like Replika a whole imaginary personality. It's a compagnion for you.
<blockquote>
**You**: Hi
**Katya**: Hi there! How are you today?
**You**: It's fine I guess. Not sleepy yet.
@ -82,4 +89,3 @@ This is example output of the `python -m ragent.demo_replika`. It is interactive
5. **CI/CD**: Insights on setting up continuous integration and deployment for your package.
Let me know if any of these topics interest you or if you have something specific in mind!
</blockquote>