Skip to content
This repository was archived by the owner on Sep 9, 2025. It is now read-only.

Commit 8a8937e

Browse files
committed
Create a proposal for a notebooks repo
Signed-off-by: Ali Maredia <amaredia@redhat.com>
1 parent b26782e commit 8a8937e

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

docs/notebooks/notebooks-repo.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Create A Repo for InstructLab Notebooks
2+
3+
## Idea Overview
4+
5+
Create a separate repository within the `instructlab` GitHub org called `notebooks`.
6+
This repository would house [Jupyter notebooks](https://jupyter.org/) organization that illustrate parts of or the entire LAB methodology.
7+
The `notebooks` repo would be a place where the maintainers of the InstructLab project can collect notebooks for the benefit of the community.
8+
All notebooks submitted to this repository would be carefully documented and tested before being merged.
9+
10+
## Repository Structure
11+
12+
The repository will have two categories of notebooks. Notebooks either live in the `combined-stages` or `use-cases` directories.
13+
14+
```bash
15+
notebooks
16+
|
17+
|- combined-stages
18+
| |- training-with-eval
19+
| |- requirements.txt
20+
| |- training-with-eval.ipynb
21+
|- use-cases
22+
| |- policy-documents
23+
| | |- requirements.txt
24+
| | |- legislative-act.ipynb
25+
| |- instruction-manuals
26+
| | |- requirements.txt
27+
| | |- how-to-build-a-house.ipynb
28+
```
29+
30+
### Notebooks for Combined InstructLab stages
31+
32+
Notebooks in the `combined-stages` directory go through parts of or the entire InstructLab workflow that users might want to reference or use.
33+
Some examples of combined stages are a notebook that runs through training then evaluation or a notebook that goes from document pre-processing to SDG.
34+
35+
### Notebooks for End-to-End (e2e) use cases
36+
37+
Notebooks in the `use-cases` directory reflect real world use cases from start to finish.
38+
39+
## Additional Info
40+
41+
This repo would not be released as a package on PYPI but initially as just `.zip` and `.tar.gz` files on GitHub.
42+
Releases would serve the purpose of giving users specific versions of notebooks they could run reliably.

0 commit comments

Comments
 (0)