From 213dc5d4ee13e0e2a6cb4554c43b52d415e89276 Mon Sep 17 00:00:00 2001 From: Jason Date: Sat, 9 Sep 2023 11:40:13 -0400 Subject: [PATCH] add comment --- docs/examples/classification.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/examples/classification.md b/docs/examples/classification.md index da748c9..69d7ef1 100644 --- a/docs/examples/classification.md +++ b/docs/examples/classification.md @@ -37,7 +37,9 @@ The function **`classify`** will perform the single-label classification. import openai import instructor -instructor.patch() +# Patch the OpenAI API to use the `ChatCompletion` +# endpoint with `response_model` enabled. +instructor.patch() def classify(data: str) -> SinglePrediction: """Perform single-label classification on the input text.""" @@ -51,7 +53,6 @@ def classify(data: str) -> SinglePrediction: }, ], ) # type: ignore - ``` ### Testing and Evaluation