You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 9, 2025. It is now read-only.
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 `stages` or `e2e` directories.
13
+
14
+
```bash
15
+
notebooks
16
+
|
17
+
|- stages
18
+
||- sdg
19
+
|||- requirements.txt
20
+
|||- sdg.ipynb
21
+
||- eval
22
+
|||- requirements.txt
23
+
|||- mt-bench.ipynb
24
+
|
25
+
|- e2e
26
+
|- combined-stages
27
+
||- training-with-eval
28
+
||- requirements.txt
29
+
||- training-with-eval.ipynb
30
+
|- use-cases
31
+
||- policy-documents
32
+
|||- requirements.txt
33
+
|||- legislative-act.ipynb
34
+
||- instruction-manuals
35
+
|||- requirements.txt
36
+
|||- how-to-build-a-house.ipynb
37
+
```
38
+
39
+
### Notebooks for different InstructLab stages
40
+
41
+
Notebooks in the `stages` directory show off one of the stages of the InstructLab process.
42
+
Some examples of stages are training, evaluation, and document pre-processing.
43
+
44
+
### Notebooks for End-to-End (e2e) use cases
45
+
46
+
Notebooks in the `e2e` directory go through parts of or the entire InstructLab workflow.
47
+
These notebooks can reflect real world use cases from start to finish, or be based on two or more stages from the `stages` directory that users might want to reference or use.
48
+
49
+
## Additional Info
50
+
51
+
This repo would not be released as a package on PYPI but initially as just `.zip` and `.tar.gz` files on GitHub.
52
+
Releases would serve the purpose of giving users specific versions of notebooks they could run reliably.
0 commit comments