Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

format: add code backticks and "mention" to Quickstart #119

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

format: add code backticks and "mention" to Quickstart #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions quickstart-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you get stuck anywhere here, please let us know on our [Slack community](http

### Installation and Setup

First things first, we'll install the Aqueduct pip package and start Aqueduct:
First things first, we'll install the Aqueduct `pip` package and start Aqueduct:

```bash
pip3 install aqueduct-ml
Expand Down Expand Up @@ -87,7 +87,7 @@ def average_strlen(strlen_table):
avg_strlen = average_strlen(strlen_table)
```

Note that metrics are denoted with the @metric decorator. Metrics can be computed over any operator, and even other metrics.
Note that metrics are denoted with the `@metric` decorator. Metrics can be computed over any operator, and even other metrics.

### Adding Checks

Expand Down Expand Up @@ -125,7 +125,7 @@ And we're done! 🎉

We've created our first workflow together, and you're off to the races. Here are some next steps:

* For more details on different ways to configure Aqueduct, check out our [Installation Guide](installation-and-configuration/).
* Check out our [example workflows](example-workflows/) for some more Aqueduct workflows.
* Check out our guide on [Workflows](workflows/) for a deep dive on how to define, preview, and create workflows.
* Check out our documentation on [Operators](operators.md), [Artifacts](artifacts.md), and [Metrics & Checks](metrics-and-checks.md) for deep dives into creating and interacting with each.
* For more details on different ways to configure Aqueduct, check out [installation-and-configuration](installation-and-configuration/ "mention").
* Check out our [example-workflows](example-workflows/ "mention") for some more Aqueduct workflows.
* Check out our guide on [workflows](workflows/ "mention") for a deep dive on how to define, preview, and create workflows.
* Check out our documentation on [operators.md](operators.md "mention"), [artifacts.md](artifacts.md "mention"), and [metrics-and-checks.md](metrics-and-checks.md "mention") for deep dives into creating and interacting with each.