github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-07-17 10:13:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs[callbacks]: update to the FileCallbackHandler documentation (#20496)

Browse Source 
**Description:** Update to the `FileCallbackHandler` documentation
**Issue:** #20493 
**Dependencies:** None
This commit is contained in:
aditya thomas 2024-04-18 08:02:21 +05:30 committed by GitHub
parent cea379e7c7
commit 8bad536c6c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/docs/modules/callbacks/filecallbackhandler.ipynb
View File

@ -5,8 +5,11 @@
"id": "63b87b91", "id": "63b87b91",
"metadata": {}, "metadata": {},
"source": [ "source": [
"# Logging to file\n", "# File logging\n",
"This example shows how to print logs to file. It shows how to use the `FileCallbackHandler`, which does the same thing as [`StdOutCallbackHandler`](/docs/modules/callbacks/#get-started), but instead writes the output to file. It also uses the `loguru` library to log other outputs that are not captured by the handler." "\n",
"LangChain provides the `FileCallbackHandler` to write logs to a file. The `FileCallbackHandler` is similar to the [`StdOutCallbackHandler`](/docs/modules/callbacks/), but instead of printing logs to standard output it writes logs to a file.\n",
"\n",
"We see how to use the `FileCallbackHandler` in this example. Additionally we use the `StdOutCallbackHandler` to print logs to the standard output. It also uses the `loguru` library to log other outputs that are not captured by the handler."
] ]
}, },
{ {
@ -45,8 +48,7 @@
} }
], ],
"source": [ "source": [
"from langchain.callbacks import FileCallbackHandler\n", "from langchain_core.callbacks import FileCallbackHandler, StdOutCallbackHandler\n",
"from langchain.chains import LLMChain\n",
"from langchain_core.prompts import PromptTemplate\n", "from langchain_core.prompts import PromptTemplate\n",
"from langchain_openai import OpenAI\n", "from langchain_openai import OpenAI\n",
"from loguru import logger\n", "from loguru import logger\n",
@ -54,16 +56,18 @@
"logfile = \"output.log\"\n", "logfile = \"output.log\"\n",
"\n", "\n",
"logger.add(logfile, colorize=True, enqueue=True)\n", "logger.add(logfile, colorize=True, enqueue=True)\n",
"handler = FileCallbackHandler(logfile)\n", "handler_1 = FileCallbackHandler(logfile)\n",
"handler_2 = StdOutCallbackHandler()\n",
"\n", "\n",
"llm = OpenAI()\n",
"prompt = PromptTemplate.from_template(\"1 + {number} = \")\n", "prompt = PromptTemplate.from_template(\"1 + {number} = \")\n",
"model = OpenAI()\n",
"\n", "\n",
"# this chain will both print to stdout (because verbose=True) and write to 'output.log'\n", "# this chain will both print to stdout (because verbose=True) and write to 'output.log'\n",
"# if verbose=False, the FileCallbackHandler will still write to 'output.log'\n", "# if verbose=False, the FileCallbackHandler will still write to 'output.log'\n",
"chain = LLMChain(llm=llm, prompt=prompt, callbacks=[handler], verbose=True)\n", "chain = prompt | model\n",
"answer = chain.run(number=2)\n", "\n",
"logger.info(answer)" "response = chain.invoke({\"number\": 2}, {\"callbacks\": [handler_1, handler_2]})\n",
"logger.info(response)"
] ]
}, },
{ {
@ -166,7 +170,7 @@
"name": "python", "name": "python",
"nbconvert_exporter": "python", "nbconvert_exporter": "python",
"pygments_lexer": "ipython3", "pygments_lexer": "ipython3",
"version": "3.11.6" "version": "3.9.6"
} }
}, },
"nbformat": 4, "nbformat": 4,