You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sourcelume.apache.org by jg...@apache.org on 2026/10/21 10:17:54 UTC

(sourcelume-site) branch main updated: Add sample page and update repository references (#6)

This is an automated email from the ASF dual-hosted git repository.

jgoodyear pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sourcelume-site.git


The following commit(s) were added to refs/heads/main by this push:
     new 4d09996  Add sample page and update repository references (#6)
4d09996 is described below

commit 4d099964550500076a95356956ebde38b6a0f057
Author: Achim Nierbeck <AN...@users.noreply.github.com>
AuthorDate: Wed Oct 21 12:17:48 2026 +0200

    Add sample page and update repository references (#6)
    
    - New Sample page describing the end-to-end training sample and its
      two record types, linking apache/sourcelume-sample
    - Link Specification and Registry pages from the index table, and the
      sample page as well
    - Mention the sample on Get involved and cross-link it from the
      registry's Simple Demo section
    - Add sourcelume-tooling and sourcelume-sample to the community
      repository list
    - Document the two spec record types on the Specification page
    
    Apache-ai: Yes
    Generated-by: pi (claude-sonnet-5-5)
    Reviewed-by: anierbeck
---
 content/pages/community.md     |  2 ++
 content/pages/get-involved.md  |  4 ++++
 content/pages/index.md         |  5 ++++-
 content/pages/registry.md      |  3 +++
 content/pages/sample.md        | 31 +++++++++++++++++++++++++++++++
 content/pages/specification.md | 18 ++++++++++++++++--
 6 files changed, 60 insertions(+), 3 deletions(-)

diff --git a/content/pages/community.md b/content/pages/community.md
index 2eb815b..296644d 100644
--- a/content/pages/community.md
+++ b/content/pages/community.md
@@ -10,6 +10,8 @@ Current Apache Sourcelume repositories include:
 - [`sourcelume-site`](https://github.com/apache/sourcelume-site) — website content and configuration
 - [`sourcelume-spec`](https://github.com/apache/sourcelume-spec) — Sourcelume specification work
 - [`sourcelume-registry`](https://github.com/apache/sourcelume-registry) — registry implementation work
+- [`sourcelume-tooling`](https://github.com/apache/sourcelume-tooling) — build-system plugins for generating, validating, and submitting records
+- [`sourcelume-sample`](https://github.com/apache/sourcelume-sample) — the end-to-end training sample
 
 For website changes, use [`apache/sourcelume-site`](https://github.com/apache/sourcelume-site). To make your pull request easier to review and apply, please follow these conventions:
 
diff --git a/content/pages/get-involved.md b/content/pages/get-involved.md
index a300b7d..d058467 100644
--- a/content/pages/get-involved.md
+++ b/content/pages/get-involved.md
@@ -35,5 +35,9 @@ ecosystem — dataset curators, model producers, and communities working on adja
 standards. If you would like to help with a specific area, say hello on the mailing list
 and we will point you to where the work is happening.
 
+New to the project? The [end-to-end sample](sample.html) walks the whole stack — training,
+records, validation, and the registry — on a small public-domain corpus, and is a good
+place to see all the pieces working together.
+
 _More detailed contribution guidance will be added here as the project's processes take
 shape._
diff --git a/content/pages/index.md b/content/pages/index.md
index b405bda..d08a6c0 100644
--- a/content/pages/index.md
+++ b/content/pages/index.md
@@ -79,7 +79,7 @@ graph TD
     PROD[Dataset producers<br/>& curators] -->|cli ingest| ATTEST[Attestation<br/>sign & verify]
     SPEC -->|defines shape of| ATTEST
 
-    ATTEST -->|signed ProvenanceRecord<br/>JSON-LD| REG[Registry<br/>Apache Atlas]
+    ATTEST -->|signed records:<br/>ProvenanceRecord,<br/>TrainingProvenanceRecord| REG[Registry<br/>Apache Atlas]
     SPEC -->|defines shape of| REG
 
     REG -->|REST / GraphQL| EXPLORER[Explorer<br/>search & provenance cards]
@@ -91,5 +91,8 @@ graph TD
 | Page | What you'll find |
 | --- | --- |
 | [About](about.html) | About Apache Sourcelume |
+| [Specification](specification.html) | The metadata specification for provenance records |
+| [Registry](registry.html) | The reference registry built on Apache Atlas |
+| [Sample](sample.html) | An end-to-end training sample with full provenance |
 | [Get involved](get-involved.html) | Mailing list, chat, and how to contribute |
 | [FAQ](faq.html) | Short answers to common questions |
diff --git a/content/pages/registry.md b/content/pages/registry.md
index 5e3f9cd..11f22e2 100644
--- a/content/pages/registry.md
+++ b/content/pages/registry.md
@@ -19,6 +19,9 @@ Want to see the registry in action right now? The `simple-demo` provides a light
 
 **[View the Simple Demo on GitHub →](https://github.com/apache/sourcelume-registry/tree/main/examples/simple-demo)**
 
+To see the whole stack — training a small model and publishing its provenance records —
+visit the [Sample](sample.html).
+
 ---
 
 ## High-Level Architecture (Target State)
diff --git a/content/pages/sample.md b/content/pages/sample.md
new file mode 100644
index 0000000..0fca6ef
--- /dev/null
+++ b/content/pages/sample.md
@@ -0,0 +1,31 @@
+Title: Sample
+license: https://www.apache.org/licenses/LICENSE-2.0
+
+The Apache Sourcelume Sample is a small end-to-end demonstration: a tiny character-level
+language model trained on public-domain text, with its training-data provenance documented and
+published along the way.
+
+## What the sample demonstrates
+
+The sample walks the flow that Sourcelume is built for, using two record types from the
+specification:
+
+- **A provenance record** — documents the training corpus itself: where the text came from,
+  which license terms it carries, and how it was prepared.
+- **A training provenance record** — documents which dataset was used to train which model,
+  in which training phase, and how completely the training data is disclosed.
+
+The sample intentionally creates both records itself instead of assuming records it did not
+author — a producer publishes what it can actually sign for.
+
+## Try it
+
+The sample lives in its own repository:
+
+- **[apache/sourcelume-sample](https://github.com/apache/sourcelume-sample)**
+
+The [README](https://github.com/apache/sourcelume-sample/blob/main/README.md) contains the
+quick start: train the model, validate both records against the current schemas, and publish
+them to a Sourcelume Registry instance. Everything runs locally on a small corpus, and the
+repository README describes the current state of each step — registry support for training
+provenance records is still landing.
diff --git a/content/pages/specification.md b/content/pages/specification.md
index 337115c..5fa4751 100644
--- a/content/pages/specification.md
+++ b/content/pages/specification.md
@@ -7,6 +7,18 @@ The Apache Sourcelume Specification defines a structured, machine-readable forma
 representing AI training-data provenance. It allows producers and curators to
 publish verifiable claims about a dataset's origin, custody, and licensing.
 
+## Record Types
+
+The specification defines two record types:
+
+- **`ProvenanceRecord`** — dataset provenance: where a dataset came from, its custody
+  chain, and the licensing terms it carries.
+- **`TrainingProvenanceRecord`** — model provenance: which datasets a model was trained
+  on, in which training phase, and how completely the training data is disclosed.
+
+A canonical record IRI identifies a record; the join between the two record types is that
+IRI, not an approval state.
+
 ## Architecture
 
 ...
@@ -14,7 +26,9 @@ The Sourcelume Specification is designed for interoperability, verifiability, an
 
 ```mermaid
 graph TD
-    A[Dataset Provenance Record] -->|expressed as| B[JSON-LD]
+    A["ProvenanceRecord (dataset)" ] -->|expressed as| B[JSON-LD]
+    T["TrainingProvenanceRecord (model)"] -->|expressed as| B
+    T -->|joins by canonical IRI| A
     B -->|structural validation| C[JSON Schema]
     B -->|semantic validation| D[SHACL]
     B -->|interoperability| E[Crosswalk Mappings]
@@ -29,7 +43,7 @@ graph TD
 
 **Architecture Flow:**
 
-1. **Dataset Provenance Record** → expressed as → **JSON-LD**
+1. **ProvenanceRecord / TrainingProvenanceRecord** → expressed as → **JSON-LD**
 2. **JSON-LD** → structural validation → **JSON Schema**
 3. **JSON-LD** → semantic validation → **SHACL**
 4. **JSON-LD** → interoperability → **Crosswalk Mappings**


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@sourcelume.apache.org
For additional commands, e-mail: commits-help@sourcelume.apache.org