From defd4b4f1111354ba2f62fb9d48a3ecd11223efb Mon Sep 17 00:00:00 2001 From: Chenyu Zhao Date: Thu, 9 Nov 2023 16:35:05 -0800 Subject: [PATCH] Clean up Fireworks provider documentation (#13157) --- docs/docs/integrations/providers/fireworks.md | 39 +++++++++++++++---- 1 file changed, 32 insertions(+), 7 deletions(-) diff --git a/docs/docs/integrations/providers/fireworks.md b/docs/docs/integrations/providers/fireworks.md index aeb4d75b43..8673509232 100644 --- a/docs/docs/integrations/providers/fireworks.md +++ b/docs/docs/integrations/providers/fireworks.md @@ -1,22 +1,47 @@ # Fireworks -This page covers how to use the Fireworks models within Langchain. +This page covers how to use [Fireworks](https://app.fireworks.ai/) models within +Langchain. -## Installation and Setup +## Installation and setup -- To use the Fireworks model, you need to have a Fireworks API key. To generate one, sign up at [app.fireworks.ai](https://app.fireworks.ai). +- Install the Fireworks client library. + + ``` + pip install fireworks-ai + ``` + +- Get a Fireworks API key by signing up at [app.fireworks.ai](https://app.fireworks.ai). - Authenticate by setting the FIREWORKS_API_KEY environment variable. -## LLM +## Authentication + +There are two ways to authenticate using your Fireworks API key: + +1. Setting the `FIREWORKS_API_KEY` environment variable. + + ```python + os.environ["FIREWORKS_API_KEY"] = "" + ``` + +2. Setting `fireworks_api_key` field in the Fireworks LLM module. + + ```python + llm = Fireworks(fireworks_api_key="") + ``` -Fireworks integrates with Langchain through the LLM module, which allows for standardized usage of any models deployed on the Fireworks models. +## Using the Fireworks LLM module -In this example, we'll work the llama-v2-13b-chat model. +Fireworks integrates with Langchain through the LLM module. In this example, we +will work the llama-v2-13b-chat model. ```python from langchain.llms.fireworks import Fireworks -llm = Fireworks(model="fireworks-llama-v2-13b-chat", max_tokens=256, temperature=0.4) +llm = Fireworks( + fireworks_api_key="", + model="accounts/fireworks/models/llama-v2-13b-chat", + max_tokens=256) llm("Name 3 sports.") ```