langchain/docs/docs/integrations/llms/beam.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "34803e5e",
   "metadata": {
    "id": "J-yvaDTmTTza"
   },
   "source": [
    "# Beam\n",
    "\n",
    "Calls the Beam API wrapper to deploy and make subsequent calls to an instance of the gpt2 LLM in a cloud deployment. Requires installation of the Beam library and registration of Beam Client ID and Client Secret. By calling the wrapper an instance of the model is created and run, with returned text relating to the prompt. Additional calls can then be made by directly calling the Beam API.\n",
    "\n",
    "[Create an account](https://www.beam.cloud/), if you don't have one already. Grab your API keys from the [dashboard](https://www.beam.cloud/dashboard/settings/api-keys)."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "76af7763",
   "metadata": {
    "id": "CfTmesWtTfTS"
   },
   "source": [
    "Install the Beam CLI"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "ef012b8d",
   "metadata": {
    "id": "G_tCCurqR7Ik"
   },
   "outputs": [],
   "source": [
    "!curl https://raw.githubusercontent.com/slai-labs/get-beam/main/get-beam.sh -sSfL | sh"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "74be8c2e",
   "metadata": {
    "id": "jJkcNqOdThQ7"
   },
   "source": [
    "Register API Keys and set your beam client id and secret environment variables:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "2a176107",
   "metadata": {
    "id": "7gQd6fszSEaH"
   },
   "outputs": [],
   "source": [
    "import os\n",
    "\n",
    "beam_client_id = \"<Your beam client id>\"\n",
    "beam_client_secret = \"<Your beam client secret>\"\n",
    "\n",
    "# Set the environment variables\n",
    "os.environ[\"BEAM_CLIENT_ID\"] = beam_client_id\n",
    "os.environ[\"BEAM_CLIENT_SECRET\"] = beam_client_secret\n",
    "\n",
    "# Run the beam configure command\n",
    "!beam configure --clientId={beam_client_id} --clientSecret={beam_client_secret}"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "64cc18b3",
   "metadata": {
    "id": "c20rkK18TrK2"
   },
   "source": [
    "Install the Beam SDK:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "a0014676",
   "metadata": {
    "id": "CH2Vop6ISNIf"
   },
   "outputs": [],
   "source": [
    "!pip install beam-sdk"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "a48d515c",
   "metadata": {
    "id": "XflOsp3bTwl1"
   },
   "source": [
    "**Deploy and call Beam directly from langchain!**\n",
    "\n",
    "Note that a cold start might take a couple of minutes to return the response, but subsequent calls will be faster!"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "c79e740b",
   "metadata": {
    "id": "KmaHxUqbSVnh"
   },
   "outputs": [],
   "source": [
    "from langchain.llms.beam import Beam\n",
    "\n",
    "llm = Beam(\n",
    "    model_name=\"gpt2\",\n",
    "    name=\"langchain-gpt2-test\",\n",
    "    cpu=8,\n",
    "    memory=\"32Gi\",\n",
    "    gpu=\"A10G\",\n",
    "    python_version=\"python3.8\",\n",
    "    python_packages=[\n",
    "        \"diffusers[torch]>=0.10\",\n",
    "        \"transformers\",\n",
    "        \"torch\",\n",
    "        \"pillow\",\n",
    "        \"accelerate\",\n",
    "        \"safetensors\",\n",
    "        \"xformers\",\n",
    "    ],\n",
    "    max_length=\"50\",\n",
    "    verbose=False,\n",
    ")\n",
    "\n",
    "llm._deploy()\n",
    "\n",
    "response = llm._call(\"Running machine learning on a remote GPU\")\n",
    "\n",
    "print(response)"
   ]
  }
 ],
 "metadata": {
  "colab": {
   "private_outputs": true,
   "provenance": []
  },
  "gpuClass": "standard",
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}