Reorganize repository into quick starts and deep dives

.github/workflows/instructlab-knowledge-e2e.yml

@@ -36,7 +36,7 @@ jobs:
                   pip install ${{ env.TESTING_PIP_DEPENDENCIES }}
                   ipython kernel install --name "python3" --user
             - name: Validate The Notebook
-              working-directory: ./notebooks/instructlab-knowledge
+              working-directory: ./quick-starts/instructlab-knowledge
               run: |
                 git clone https://github.com/instructlab/instructlab.git
                 python3 instructlab/scripts/validate_notebook.py ${{ matrix.notebooks_to_test }}
@@ -48,6 +48,6 @@ jobs:
                 sleep 1
                 echo "Inference mock server started on port 11434"
             - name: Run End To End Tests
-              working-directory: ./notebooks/instructlab-knowledge
+              working-directory: ./quick-starts/instructlab-knowledge
               # NOTE: for this to work, cells with parameters need to be tagged as parameters in the target notebooks
               run: papermill ${{ matrix.notebooks_to_test }} ${{ matrix.notebooks_to_test }}.tmp -p API_URL $API_URL -p MODEL_ID $MODEL_ID

README.md

@@ -2,35 +2,33 @@
 
 The `examples` repo is a place where the maintainers of the project can collect notebooks for the benefit of the community.
 
-This repository contains [Jupyter notebooks](https://jupyter.org/) and other examples that illustrate parts of or an entire model customization pipeline.
+This repository contains [Jupyter notebooks](https://jupyter.org/) and scripts that illustrate model customization pipelines or stages of an model customization pipeline.
 
 ## Repository Structure
 
-Notebooks either live in the `combined-stages` or `use-cases` directories.
+Examples either live in the `quick-starts` or `deep-dives` directories.
 
 ```bash
 examples
 |
-|- notebooks
-    |
-    |- combined-stages
-    |   |- training-with-eval
-    |       |- requirements.txt
-    |       |- training-with-eval.ipynb
-    |- use-cases
-    |   |- policy-documents
-    |   |   |- requirements.txt
-    |   |   |- legislative-act.ipynb
-    |   |- instruction-manuals
-    |   |   |- requirements.txt
-    |   |   |- how-to-build-a-house.ipynb
+|- quick-starts
+|   |
+|   |- instructlab-knowledge
+|       |- instructlab-knowledge.ipynb
+|
+|- deep-dives
+|   |- document-conversion
+|       |- enrichment.py
+|       |- vlm.py
+|       |- force-ocr.py
 ```
 
-### Notebooks for Combined InstructLab stages
+### Quick Starts
+
+Users that want jump right into running a specific model customization pipeline should find everything they need in the `quick-starts` directory.
 
-Notebooks in the `combined-stages` directory go through parts of or an entire model customization workflow that users might want to reference or use.
-Some examples of combined stages are a notebook that runs through training then evaluation or a notebook that goes from document pre-processing to synthetic data generation.
+Each directory under `quick-starts` is for a different model customization pipeline or use case.
 
-### Notebooks for End-to-End (e2e) use cases
+### Deep Dives
 
-Notebooks in the `use-cases` directory reflect real world use cases from start to finish.
+Examples in `deep-dives` are modular notebooks or comprehensive tutorials that encompass or are part of a single stage of a model customization pipeline.

deep-dives/README.md

@@ -0,0 +1,3 @@
+# Deep Dives
+
+Examples in `deep-dives` are modular notebooks or comprehensive tutorials that encompass a stages of a model customization pipeline.