From 1c327f5175a0372949a55b372b090f65f0aec3c0 Mon Sep 17 00:00:00 2001 From: Edgar Ruiz Date: Tue, 23 Apr 2024 14:18:06 -0500 Subject: [PATCH] Removes problematic links --- README.md | 3 +-- README.qmd | 23 ++++++++++++----------- vignettes/openai-gpt.Rmd | 5 +---- 3 files changed, 14 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 92319fb..0837df3 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,7 @@ back-ends as time goes by: -OpenAI +OpenAI GPT Models accessible via the OpenAI’s REST API. chattr provides a convenient way to interact with GPT 4, and 3.5. diff --git a/README.qmd b/README.qmd index 54a45ff..537a2f3 100644 --- a/README.qmd +++ b/README.qmd @@ -30,15 +30,16 @@ url <- urls[grepl(".io", urls)][[1]] ``` -- [Intro](#intro) -- [Install](#install) -- [Available models](#available-models) -- [Using](#using) - - [The App](#the-app) - - [Additional ways to interact](#additional-ways-to-interact) -- [How it works](#how-it-works) -- [Keyboard Shortcut](#keyboard-shortcut) - - [How to setup the keyboard shortcut](#how-to-setup-the-keyboard-shortcut) + +- [Intro](#intro) +- [Install](#install) +- [Available models](#available-models) +- [Using](#using) + - [The App](#the-app) + - [Additional ways to interact](#additional-ways-to-interact) +- [How it works](#how-it-works) +- [Keyboard Shortcut](#keyboard-shortcut) + - [How to setup the keyboard shortcut](#how-to-setup-the-keyboard-shortcut) @@ -61,9 +62,9 @@ remotes::install_github("mlverse/chattr") `chattr` provides two main integration with two main LLM back-ends. Each back-end provides access to multiple LLM types. The plan is to add more back-ends as time goes by: -| Provider | Models | Setup Instructions | +| Provider | Models | Setup Instructions | |:-----------------:|:--------------------------------:|:-----------------:| -| [OpenAI](https://platform.openai.com/docs/introduction) | GPT Models accessible via the OpenAI's REST API. `chattr` provides a convenient way to interact with GPT 4, and 3.5. | [Interact with OpenAI GPT models](https://mlverse.github.io/chattr/articles/openai-gpt.html) | +| OpenAI | GPT Models accessible via the OpenAI's REST API. `chattr` provides a convenient way to interact with GPT 4, and 3.5. | [Interact with OpenAI GPT models](https://mlverse.github.io/chattr/articles/openai-gpt.html) | | [LLamaGPT-Chat](https://github.com/kuvaus/LlamaGPTJ-chat) | LLM models available in your computer. Including GPT-J, LLaMA, and MPT. Tested on a [GPT4ALL](https://gpt4all.io/index.html) model. **LLamaGPT-Chat** is a command line chat program for models written in C++. | [Interact with local models](https://mlverse.github.io/chattr/articles/backend-llamagpt.html) | | [GitHub Copilot](https://docs.posit.co/ide/user/ide/guide/tools/copilot.html) | AI pair programmer that offers autocomplete-style suggestions as you code | [Interact with GitHub Copilot Chat](https://mlverse.github.io/chattr/articles/copilot-chat.html) | diff --git a/vignettes/openai-gpt.Rmd b/vignettes/openai-gpt.Rmd index ba533cd..bad544e 100644 --- a/vignettes/openai-gpt.Rmd +++ b/vignettes/openai-gpt.Rmd @@ -27,8 +27,7 @@ to make the "chatting" experience with the GPT models seamless. OpenAI requires a **secret key** to authenticate your user. It is required for any application non-OpenAI application, such as `chattr`, to have one in order to function. A key is a long alphanumeric sequence. The sequence is created in -the OpenAI portal. To obtain your **secret key**, follow this link: -[OpenAI API Keys](https://platform.openai.com/account/api-keys) +the OpenAI portal. By default, `chattr` will look for the **secret key** inside the a Environment Variable called `OPENAI_API_KEY`. Other packages that integrate with OpenAI use @@ -79,8 +78,6 @@ To switch back to GPT 4, run: chattr_use("gpt4") ``` -To see the latest list which endpoint to use, go to : [Model Endpoint Compatibility](https://platform.openai.com/docs/models/model-endpoint-compatibility) - ## Data files and data frames Because it is information about your environment and work space, by default