From 71dc7bfe16f4b1b24145b074d5d7cb8370b20c65 Mon Sep 17 00:00:00 2001
From: Li Yin <li.yin.gravity@gmail.com>
Date: Sun, 17 Nov 2024 19:16:50 -0800
Subject: [PATCH] update the root poetry lock file and add in the update the
 version

---
 adalflow/PACKAGING.md                  | 15 ++++++++++++++-
 poetry.lock                            |  9 +++++----
 use_cases/unsorted/simple_qa_memory.py |  5 ++---
 3 files changed, 21 insertions(+), 8 deletions(-)

diff --git a/adalflow/PACKAGING.md b/adalflow/PACKAGING.md
index c7f4d26c..de951f1d 100644
--- a/adalflow/PACKAGING.md
+++ b/adalflow/PACKAGING.md
@@ -1,4 +1,4 @@
-#Poetry Packaging Guide
+# Poetry Packaging Guide
 ## Development
 
 To install optional dependencies, use the following command:
@@ -27,3 +27,16 @@ Better to use a colab to update the whl file and test the installation.
 ```bash
 pip install "dist/adalflow-0.1.0b1-py3-none-any.whl[openai,groq,faiss]"
 ```
+
+
+## Update the version
+
+1. Update the version in `pyproject.toml`
+2. Add the version number in `adalflow/__init__.py`
+3. Build the package 
+4. Test the package locally
+5. Push the changes to the repository
+6. Ensure to run `poetry lock --no-update` in the root directory (project-level) to update the lock file for other directories such as `tutorials`, `use_cases`, `benchmarks`, etc.
+7. Update the `CHANGELOG.md` file with the new version number and the changes made in the new version.
+
+## TODO: we need to automate the version update process. Help is appreciated.
\ No newline at end of file
diff --git a/poetry.lock b/poetry.lock
index 09358530..92749681 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -44,8 +44,8 @@ testing = ["bitsandbytes", "datasets", "diffusers", "evaluate", "parameterized",
 
 [[package]]
 name = "adalflow"
-version = "0.2.2"
-description = "The Library to Build and Auto-optimize Any LLM Task Pipeline"
+version = "0.2.5"
+description = "The Library to Build and Auto-optimize LLM Applications"
 optional = false
 python-versions = ">=3.9, <4.0"
 files = []
@@ -54,6 +54,7 @@ develop = true
 [package.dependencies]
 backoff = "^2.2.1"
 botocore = "^1.34.149"
+colorama = "^0.4.6"
 diskcache = "^5.6.3"
 jinja2 = "^3.1.3"
 jsonlines = "^4.0.0"
@@ -6128,5 +6129,5 @@ multidict = ">=4.0"
 
 [metadata]
 lock-version = "2.0"
-python-versions = ">=3.11, <4.0
-content-hash = "4d44108f296caafc4f938300bcd09141d2bed45c88bfbed06081be67f01ae868"
+python-versions = ">=3.11, <4.0"
+content-hash = "e37147771ba46212166b62327cb83b76012da7ddbcc57aa5088ff7418eef2393"
diff --git a/use_cases/unsorted/simple_qa_memory.py b/use_cases/unsorted/simple_qa_memory.py
index 3a7646f7..d0a1b0b6 100644
--- a/use_cases/unsorted/simple_qa_memory.py
+++ b/use_cases/unsorted/simple_qa_memory.py
@@ -1,6 +1,5 @@
-"""
-We just need to very basic generator that can be used to generate text from a prompt.
-"""
+# TODO: We need an example to demonstrate how to use the memory component in the genertor.
+
 
 # from adalflow.core.component import Component
 # from adalflow.core.memory import Memory