fix: highlight schema requirement

Azure · Oct 17, 2023 · d59aa34 · d59aa34
1 parent 6dd0e6a
commit d59aa34
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/cli/jobs/pipelines-with-components/pipeline_job_with_flow_as_component/README.md b/cli/jobs/pipelines-with-components/pipeline_job_with_flow_as_component/README.md
@@ -4,6 +4,9 @@ Prerequirements:
 1. `.promptflow/flow.tools.json` in the flow directory is required to use a flow as a component. Usually you can use `pf flow validate` or `pf run validate` to generate it.
 2. You should either update connection name in `flow.dag.yaml` or update `connection.yaml` with your own api information and use `pf connection create --file connection.yaml` to create a workspace connection.
 3. You need to either edit the compute cluster in `pipeline.yml` or create a compute cluster named `cpu-cluster` in your workspace.
+4. Please ensure that there are `$schema` in your `flow.dag.yaml` and `run.yaml`
+    1. `flow.dag.yaml`: `$schema: https://azuremlschemas.azureedge.net/promptflow/latest/Flow.schema.json`
+    2. `run.yaml`: `$schema: https://azuremlschemas.azureedge.net/promptflow/latest/Run.schema.json`
 
 After that, you can run `az ml job create --file pipeline.yml` to submit the pipeline job.
 

diff --git a/sdk/python/jobs/pipelines/1l_flow_in_pipeline/flow_in_pipeline.ipynb b/sdk/python/jobs/pipelines/1l_flow_in_pipeline/flow_in_pipeline.ipynb
@@ -114,6 +114,10 @@
     "\n",
     "- For more information about how to author a flow, please check [official doc site](https://microsoft.github.io/promptflow/).\n",
     "- If `.promptflow/flow.tools.json` is not generated yet or is not up-to-date, you may use `pf flow validate` or `pf run validate` to generate it - [reference doc](https://microsoft.github.io/promptflow/reference/pf-command-reference.html).\n",
+    "- Please ensure that there are `$schema` in your `flow.dag.yaml` and `run.yaml`, we depends on that to identify whether this is a flow\n",
+    "  - `flow.dag.yaml`: `$schema: https://azuremlschemas.azureedge.net/promptflow/latest/Flow.schema.json`\n",
+    "  - `run.yaml`: `$schema: https://azuremlschemas.azureedge.net/promptflow/latest/Run.schema.json`\n",
+    "\n",
     "\n",
     "Then we can load its flow dag yaml as a component like regular component specs. Here we reused [the flow definition yaml in CLI examples](../../../../../cli/jobs/pipelines-with-components/pipeline_job_with_flow_as_component/web_classification/flow.dag.yaml)."
    ]