Introduction

Currently, the CLI is the primary client interface for technical users to interact with PIPES. For example, by using CLI, we can initialize the project, create model run, retrieve model information, checkin dataset, etc. In the following section, we’ll introduce pipes commands, and see how to use the them to build project pipelines in PIPES to assist the project management and collaboration in use cases.

There are different workflows on the user side when working with PIPES on your project.

For an informational overview of the user workflow process, see the Reference section.

The information in the CLI How To Guides is broken down into sections.

Setup:

• Installation
• Commands

Workflow:

• Initialize a project
• Create a model run
• Checkin a dataset
• Create tasks
• Check progress
• Close a model run
• Planning tasks
• Update project and runs

Warning

We migrated our PIPES API from gRPC to REST, which introduced some changes in behavior. Some workflows in the following documentation may be unstable, as they have not been fully tested yet. If you encounter any issues, please reach out to the PIPES team.