docs: Evaluation module demo and documentation

DEMO/README.md

@@ -66,6 +66,25 @@ It covers:
 
 * A showcase of the pre-made `RagHook` class and performing different RAG type tasks on `VectorStoreSearchOutput` results including classification, reranking and keyword identication, and how to customise the specific task using this class.
 
+### 5. Evaluating VectorStore Performance with Metrics : `evaluation_workflow_demo.ipynb`
+
+This notebook demonstrates how to use the Evaluation module to assess the performance of one or more VectorStore instances against ground-truth labelled data.
+
+It covers:
+
+* An introduction to the Evaluation module and its multi-class, single-label classification focus.
+
+* The available evaluation metrics
+
+* Creating multiple VectorStore instances with varying data coverage to showcase performance differences.
+
+* Instantiating an `Evaluation` object with ground truth data and selected metrics.
+
+* Running the `evaluate()` method to compute metrics across multiple VectorStores.
+
+* Memory-efficient evaluation using callable functions to load VectorStores on-demand, useful when evaluating many or large VectorStores.
+
+> **Note:** The Evaluation module is currently in development and its API is subject to change in future releases.
 ---
 
 ## Installation of classifai

DEMO/data/fake_soc_eval_queries.csv

@@ -0,0 +1,49 @@
+text,label
+"grows apples and berries in orchards",101
+"raises cows for milk and produces dairy goods",102
+"lays bricks and concrete blocks to build walls",103
+"builds custom wooden furniture and fittings",104
+"installs and repairs wiring in residential buildings",105
+"fixes leaking pipes and drainage systems",106
+"develops and tests software applications",107
+"analyzes datasets to produce business insights",108
+"prepares and reviews financial records for compliance",109
+"teaches students in schools and colleges",110
+"provides direct patient care in hospitals",111
+"prepares meals in a busy restaurant kitchen",112
+"creates visual branding assets and illustrations",113
+"diagnoses and repairs faults in cars and trucks",114
+"captures and edits video content for events",115
+"prepares espresso drinks as a cafe barista",116
+"creates personal workout plans for clients",117
+"organizes archives and historical records",118
+"writes technical manuals for software products",119
+"conducts lab experiments in biology and chemistry",120
+"investigates crimes and gathers forensic evidence",121
+"responds to fires and emergency rescue calls",122
+"operates commercial aircraft for passenger travel",123
+"writes scripts for films and television",124
+"composes original music for performances",125
+"coaches athletes to improve competitive performance",126
+"designs clothing collections and fashion accessories",127
+"helps clients buy and sell residential property",128
+"plans weddings and coordinates vendors",129
+"treats pets and livestock as a veterinarian",130
+"supports families with counseling and social care",131
+"advises businesses on strategy and growth",132
+"manages warehousing and transportation logistics",133
+"tests applications for bugs and usability issues",134
+"builds statistical models to forecast trends",135
+"recruits candidates and manages employee relations",136
+"assists head chefs with kitchen operations",137
+"mixes cocktails and serves drinks at a bar",138
+"plans travel itineraries and bookings for clients",139
+"designs gameplay mechanics for video games",140
+"installs office lighting systems and electrical fixtures",106
+"maintains gas appliances and heating pipework",105
+"builds mobile apps for smartphones and tablets",108
+"analyzes sales and market data for business decisions",109
+"teaches students with special educational needs",111
+"assists with childbirth and postnatal care",112
+"protects company systems from cyber attacks",120
+"organizes entertainment and activities on cruise ships",123