Added docs for trigger interface #2806

htahir1 · 2024-06-25T14:24:26Z

Describe changes

I added a bunch of docs I felt were missing

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation accordingly.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2024-06-25T14:24:32Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

docs/book/how-to/build-pipelines/compose-pipelines.md

docs/book/how-to/build-pipelines/configuring-a-pipeline-at-runtime.md

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

docs/book/how-to/build-pipelines/compose-pipelines.md

schustmi · 2024-06-26T08:10:54Z

docs/book/how-to/build-pipelines/compose-pipelines.md

+```
+
+{% hint style="info" %}
+Here we are calling one pipeline from within another pipeline, so functionally the `data_loading_pipeline` is functioning as a step within the `training_pipeline` though when it runs it is executing as an entirely separate pipeline. These two pipelines will be visible as separate pipelines within the ZenML dashboard, but practically they are working together within the umbrella of the `training_pipeline`. In order to trigger a pipeline from another, see [here](../trigger-pipelines/trigger-a-pipeline-from-another.md)


though when it runs it is executing as an entirely separate pipeline It is not though right, it just adds the steps to training_pipeline?

Actually this entire paragraph is wrong. They will not show up as separate pipelines

I just used what @strickvl said :D

schustmi · 2024-06-26T08:14:09Z

docs/book/how-to/trigger-pipelines/trigger-a-pipeline-from-rest-api.md

+
+There are three calls that need to be made in order to trigger a pipeline from the REST API:
+
+1. `GET /pipelines?name=<PIPELINE_NAME>` -> This returns the <PIPELINE_ID>


This returns a list of responses, which they need to parse the ID from

schustmi · 2024-06-26T08:14:27Z

docs/book/how-to/trigger-pipelines/trigger-a-pipeline-from-rest-api.md

+There are three calls that need to be made in order to trigger a pipeline from the REST API:
+
+1. `GET /pipelines?name=<PIPELINE_NAME>` -> This returns the <PIPELINE_ID>
+2. `GET /pipeline_builds?pipeline_id=<PIPELINE_ID>` -> This returns the build ID


This returns a list again, which they need to parse the ID from

schustmi · 2024-06-26T08:14:53Z

docs/book/how-to/trigger-pipelines/trigger-a-pipeline-from-rest-api.md

+2. `GET /pipeline_builds?pipeline_id=<PIPELINE_ID>` -> This returns the build ID
+3. `POST /pipeline_builds/<BUILD_ID>/runs` -> This runs the pipeline. You can pass the [PipelineRunConfiguration](https://sdkdocs.zenml.io/latest/core_code_docs/core-config/#zenml.config.pipeline_run_configuration.PipelineRunConfiguration) in the body
+
+The above set of REST calls means that you can only trigger a pipeline that has been [built before](../customize-docker-builds/reuse-docker-builds.md).


We should probably mention again that this needs a build with a remote stack etc.

schustmi · 2024-06-26T08:15:06Z

docs/book/how-to/trigger-pipelines/trigger-a-pipeline-from-client.md

@@ -0,0 +1,29 @@
+---
+description: >-
+  Trigger a pipeline from the rest API.


schustmi · 2024-06-26T08:15:34Z

docs/book/how-to/trigger-pipelines/trigger-a-pipeline-from-client.md

+  Trigger a pipeline from the rest API.
+---
+
+# Trigger a pipeline from another


github-actions · 2024-06-26T12:22:00Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 38.8%, saving 26.43 KB.

Filename	Before	After	Improvement	Visual comparison
`docs/book/.gitbook/assets/rest_api_step_1.png`	22.31 KB	12.68 KB	-43.2%	View diff
`docs/book/.gitbook/assets/rest_api_step_2.png`	45.76 KB	28.96 KB	-36.7%	View diff

236 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

docs/book/how-to/build-pipelines/compose-pipelines.md

Co-authored-by: Michael Schuster <schustmi@users.noreply.github.com>

…nml into doc/trigger-client-interface

htahir1 added 3 commits June 25, 2024 16:19

Adding trigger docs

d88efd5

Adding trigger docs

c0d3d45

Adding trigger docs

2d5138f

htahir1 added the documentation Improvements or additions to documentation label Jun 25, 2024

htahir1 requested review from strickvl and schustmi June 25, 2024 14:24

github-actions bot added the internal To filter out internal PRs and issues label Jun 25, 2024

htahir1 and others added 2 commits June 25, 2024 16:26

Adding trigger docs

f67b9a7

Merge branch 'develop' into doc/trigger-client-interface

88f1a75

strickvl requested changes Jun 25, 2024

View reviewed changes

htahir1 and others added 3 commits June 25, 2024 16:52

Apply suggestions from code review

c6e4eaf

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

Adding trigger docs

47d1959

Adding trigger docs

2894de5

htahir1 requested a review from strickvl June 25, 2024 14:59

strickvl approved these changes Jun 25, 2024

View reviewed changes

docs/book/how-to/build-pipelines/compose-pipelines.md Outdated Show resolved Hide resolved

Update docs/book/how-to/build-pipelines/compose-pipelines.md

bb821d2

schustmi requested changes Jun 26, 2024

View reviewed changes

htahir1 added 4 commits June 26, 2024 14:14

Adding trigger docs

fddfeb5

Adding trigger docs

1fab57f

Adding trigger docs

e1aa7c5

Adding trigger docs

471d1a3

htahir1 requested a review from schustmi June 26, 2024 12:19

Optimised images with calibre/image-actions

a967d13

schustmi reviewed Jun 26, 2024

View reviewed changes

docs/book/how-to/build-pipelines/compose-pipelines.md Outdated Show resolved Hide resolved

htahir1 and others added 3 commits June 26, 2024 14:29

Update docs/book/how-to/build-pipelines/compose-pipelines.md

01f4d81

Co-authored-by: Michael Schuster <schustmi@users.noreply.github.com>

Adding trigger docs

e1b1380

Merge branch 'doc/trigger-client-interface' of github.com:zenml-io/ze…

1a4fac6

…nml into doc/trigger-client-interface

htahir1 requested a review from strickvl June 26, 2024 12:53

schustmi approved these changes Jun 26, 2024

View reviewed changes

htahir1 and others added 3 commits June 26, 2024 15:00

Adding trigger docs

b5c0114

Chaned response and request

51e7e60

try other exception option

4130369

strickvl approved these changes Jun 26, 2024

View reviewed changes

htahir1 added 2 commits June 26, 2024 16:07

Adding trigger docs

1b5ebe3

Adding trigger docs

20bb043

htahir1 merged commit 6e60094 into develop Jun 27, 2024
8 checks passed

htahir1 deleted the doc/trigger-client-interface branch June 27, 2024 09:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added docs for trigger interface #2806

Added docs for trigger interface #2806

htahir1 commented Jun 25, 2024

coderabbitai bot commented Jun 25, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

schustmi Jun 26, 2024

schustmi Jun 26, 2024

strickvl Jun 26, 2024

htahir1 Jun 26, 2024

schustmi Jun 26, 2024

schustmi Jun 26, 2024

schustmi Jun 26, 2024

schustmi Jun 26, 2024

schustmi Jun 26, 2024

github-actions bot commented Jun 26, 2024


		There are three calls that need to be made in order to trigger a pipeline from the REST API:

		1. `GET /pipelines?name=<PIPELINE_NAME>` -> This returns the <PIPELINE_ID>

Added docs for trigger interface #2806

Added docs for trigger interface #2806

Conversation

htahir1 commented Jun 25, 2024

Describe changes

Pre-requisites

Types of changes

coderabbitai bot commented Jun 25, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jun 26, 2024

CodeRabbit Configration File (`.coderabbit.yaml`)