Add a basic README.md files for each example

This also adds simple README.md files up the directory hierarchy, just so that users navigating the GitHub repository have a bit more context as they dig into the docs/ folder. Signed-off-by: Ben Browning <[email protected]>
instructlab · Jan 31, 2025 · f06fb6c · f06fb6c
1 parent 887981c
commit f06fb6c
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,5 @@
+# Docs
+
+The markdown files directly within this folder are more in-depth documentation about the SDG library.
+
+The [examples/](examples) folder contains multiple examples demonstrating how to use different parts of SDG, and is a good resource to see how some things can be accomplished that may not be explicitly documented elsewhere.
diff --git a/docs/examples/README.md b/docs/examples/README.md
@@ -0,0 +1,3 @@
+# Examples
+
+Within these folders, you'll find various examples for how to use different aspects of the SDG library.
diff --git a/docs/examples/blocks/README.md b/docs/examples/blocks/README.md
@@ -0,0 +1,3 @@
+# Block examples
+
+Each example in this directory shows how to use different Blocks within a Pipeline.
diff --git a/docs/examples/mix_datasets/README.md b/docs/examples/mix_datasets/README.md
@@ -0,0 +1,5 @@
+# Data mixing
+
+This folder provides a couple of examples for how to mix different datasets using our `mix_datasets` API in the file [example_mixing.py](example_mixing.py). The `mix_datasets` API requires writing recipe yaml files, and you'll find a couple of those in here as well that are used by the examples. Each recipe yaml has comments at the top of the file explaining what the recipe does.
+
+For a more general overview of what data mixing is, see [data_mixing.md](../../data_mixing.md).
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Examples

		Within these folders, you'll find various examples for how to use different aspects of the SDG library.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Block examples

		Each example in this directory shows how to use different Blocks within a Pipeline.