README.md in nano-bots-0.0.2 vs README.md in nano-bots-0.0.3

- old
+ new

@@ -11,25 +11,27 @@ - [Docker](#docker) - [Usage](#usage) - [Command Line](#command-line) - [Library](#library) - [Cartridges](#cartridges) +- [Providers](#providers) +- [Debugging](#debugging) - [Development](#development) - [Publish to RubyGems](#publish-to-rubygems) ## Setup For a system usage: ```sh -gem install nano-bots -v 0.0.2 +gem install nano-bots -v 0.0.3 ``` To use it in a project, add it to your `Gemfile`: ```ruby -gem 'nano-bots', '~> 0.0.2' +gem 'nano-bots', '~> 0.0.3' ``` ```sh bundle install ``` @@ -39,16 +41,25 @@ ```sh export OPENAI_API_ADDRESS=https://api.openai.com export OPENAI_API_ACCESS_TOKEN=your-token export OPENAI_API_USER_IDENTIFIER=your-user -export NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots -export NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges +# export NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots +# export NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges ``` -Alternatively, if your current directory has a `.env` file with the environment variables, they will be automatically loaded. +Alternatively, if your current directory has a `.env` file with the environment variables, they will be automatically loaded: +```sh +OPENAI_API_ADDRESS=https://api.openai.com +OPENAI_API_ACCESS_TOKEN=your-token +OPENAI_API_USER_IDENTIFIER=your-user + +# NANO_BOTS_STATE_DIRECTORY=/home/user/.local/state/nano-bots +# NANO_BOTS_CARTRIDGES_DIRECTORY=/home/user/.local/share/nano-bots/cartridges +``` + ## Docker Clone the repository and copy the Docker Compose template: ``` @@ -63,26 +74,31 @@ version: '3.7' services: nano-bots: image: ruby:3.2.2-slim-bullseye - command: sh -c "gem install nano-bots -v 0.0.2 && bash" + command: sh -c "gem install nano-bots -v 0.0.3 && bash" environment: OPENAI_API_ADDRESS: https://api.openai.com OPENAI_API_ACCESS_TOKEN: your-token OPENAI_API_USER_IDENTIFIER: your-user volumes: - ./your-cartridges:/cartridges + # - ./your-data:/data ``` Enter the container: ```sh docker compose run nano-bots ``` Start playing: ```sh +nb - - eval "hello" +nb - - repl + +nb cartridges/assistant.yml - eval "hello" nb cartridges/assistant.yml - repl ``` ## Usage @@ -91,10 +107,13 @@ After installing the gem, the `nb` binary command will be available for your project or system. Examples of usage: ```bash +nb - - eval "hello" +# => Hello! How may I assist you today? + nb to-en-us-translator.yml - eval "Salut, comment ça va?" # => Hello, how are you doing? nb midjourney.yml - eval "happy cyberpunk robot" # => A cheerful and fun-loving robot is dancing wildly amidst a @@ -113,10 +132,12 @@ # allowing it to generate human-like responses and perform # a range of language-related tasks. ``` ```bash +nb - - repl + nb assistant.yml - repl ``` ```text 🤖> Hi, how are you doing? @@ -143,10 +164,20 @@ require 'securerandom' SecureRandom.hex # => 6ea6c43c42a1c076b1e3c36fa349ac2c ``` +### Debugging + +```sh +nb - - cartridge +nb cartridge.yml - cartridge + +nb - STATE-KEY state +nb cartridge.yml STATE-KEY state +``` + ### Library To use it as a library: ```ruby @@ -196,10 +227,20 @@ user-identifier: ENV/OPENAI_API_USER_IDENTIFIER ``` Check the Nano Bots specification to learn more about [how to build cartridges](https://icebaker.github.io/nano-bots/#/README?id=cartridges). +## Providers + +Currently supported providers: + +- [ ] [Vicuna](https://github.com/lm-sys/FastChat) +- [x] [Open AI](https://platform.openai.com/docs/api-reference) +- [ ] [Google PaLM](https://developers.generativeai.google/) +- [ ] [Alpaca](https://github.com/tatsu-lab/stanford_alpaca) +- [ ] [LLaMA](https://github.com/facebookresearch/llama) + ## Development ```bash bundle rubocop -A @@ -211,7 +252,7 @@ ```bash gem build nano-bots.gemspec gem signin -gem push nano-bots-0.0.2.gem +gem push nano-bots-0.0.3.gem ```