From 09c98a460bb9f48d66bfd29fb3c4d62900c54171 Mon Sep 17 00:00:00 2001
From: Paillat <git@electronique.cc>
Date: Sat, 17 Jun 2023 11:51:35 +0200
Subject: [PATCH] docs(tokens.py): add docstring explaining the purpose of the
 file and its reference

---
 utils/tokens.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/utils/tokens.py b/utils/tokens.py
index 835bcde..3be7b3a 100644
--- a/utils/tokens.py
+++ b/utils/tokens.py
@@ -1,3 +1,10 @@
+'''
+This file's purpose is to count the number of tokens used by a list of messages.
+It is used to check if the token limit of the model is reached.
+
+Reference: https://github.com/openai/openai-cookbook/blob/main/examples/How_to_format_inputs_to_ChatGPT_models.ipynb
+'''
+
 import tiktoken
 
 async def num_tokens_from_messages(messages, model="gpt-3.5-turbo"):