Put YAML and Python DSL on equal footing in /compute/pipelines/ docs#881
Merged
Merged
Conversation
Earlier framing leaned against the YAML authoring path — "Advanced", "we recommend the DSL", "no YAML to maintain", "Python-first alternative". Both paths are supported and reach the same engine; the docs should treat them as equal first-class options and let the reader pick. Five edits: - README.mdx "Why Clarifai Pipelines" bullet — rewrite from "Python-first authoring ... no parallel YAML to keep in sync" to "Python or YAML — both first-class ... pick whichever fits your team." - README.mdx Quick Start tip — rename from "Python-first alternative" to "Two upload paths"; describe each path's strengths (YAML for explicit version-controlled config, DSL for code-first authoring) without ranking them. - README.mdx "Where to go next" — drop "Advanced:" prefix from the YAML / config-based pipelines link. - create-api.md title — drop "Advanced:" prefix. Now just "YAML / Config-Based Pipelines". - create-api.md tip callout — rewrite from "we recommend the Pipeline DSL ... No YAML to maintain" to "Clarifai Pipelines support two authoring paths ... pick whichever fits your team." Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates /compute/pipelines/ docs messaging to present YAML/config-based pipelines and the Python DSL as equally supported authoring paths, removing “Advanced” framing for YAML.
Changes:
- Rewrites the Pipelines landing page copy to describe Python DSL and YAML/config as first-class options.
- Updates the Quick Start callout to describe two upload paths (YAML scaffold vs DSL file) without ranking.
- Renames the YAML/config guide title and corresponding “Where to go next” link text to drop the “Advanced:” prefix.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/compute/pipelines/README.mdx | Reframes the landing page + Quick Start callout and updates YAML link text to remove “Advanced” framing. |
| docs/compute/pipelines/create-api.md | Retitles the YAML/config guide and rewrites the top tip to present DSL and YAML as equal authoring paths. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * **Schedule training on your inference clusters.** Training, evaluation, and inference workloads share the same Compute Orchestration clusters — no separate cluster to provision and pay for. Run a training job overnight on the same nodepool that serves your daytime inference traffic. | ||
| * **Outputs land in the model registry.** Trained and quantized models from pipeline runs are registered directly into Clarifai's model registry, ready to serve or evaluate further without an export step. | ||
| * **Python-first authoring.** Define pipelines as decorated Python functions with the [DSL](dsl-reference.md) — no parallel YAML to keep in sync. | ||
| * **Python or YAML — both first-class.** Author pipelines as decorated Python functions with the [DSL](dsl-reference.md), or as YAML config with [scaffold templates](create-api.md). Same engine, same templates, same upload path — pick whichever fits your team. |
Comment on lines
126
to
129
| * **[Manage Pipelines](manage.md)** — list, validate, and inspect pipelines on the platform. | ||
| * **[Manage Pipeline Runs](manage-run.md)** — monitor, pause, resume, and cancel runs. | ||
| * **[Advanced: YAML / config-based pipelines](create-api.md)** — the scaffold-directory authoring flow underneath the templates, useful for existing pipelines or workflows that need explicit YAML control. | ||
| * **[YAML / config-based pipelines](create-api.md)** — the YAML config authoring path, useful for explicit version-controlled configuration, YAML-first workflows, or as a reference for the scaffold-directory file structure. | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Earlier framing in PR #877 + #879 leaned against the YAML authoring path — calling it "Advanced", saying "we recommend the DSL", "no YAML to maintain", etc. Both paths are first-class options that reach the same engine; the docs should treat them as equal and let readers pick.
Five edits
Test plan
🤖 Generated with Claude Code