Skip to content

Commit

Permalink
add note about needing to change directories
Browse files Browse the repository at this point in the history
Signed-off-by: nikki everett <nikki@union.ai>
  • Loading branch information
neverett committed Jan 16, 2024
1 parent 0272c69 commit f3b0080
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/getting_started/quickstart_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ Next, run the workflow in the example workflow file with `pyflyte run`. The init
refers to the function decorated with `@task` or `@workflow` that you wish to run:

```{prompt} bash $
cd hello-world
pyflyte run example.py hello_world_wf
```

Expand All @@ -73,6 +72,14 @@ You can also provide a `name` argument to the workflow:
pyflyte run example.py hello_world_wf --name Ada
```

:::{note}
If you created a "Hello, world" project using `pyflyte init`, you will need to change directories before running the workflow:
```{prompt} bash $
cd hello-world
pyflyte run example.py hello_world_wf
```
:::

## The @task and @workflow decorators

In this example, the file `example.py` contains a task and a workflow, decorated with the `@task` and `@workflow` decorators, respectively. You can invoke tasks and workflows like regular Python methods, and even import and use them in other Python modules or scripts.
Expand Down

0 comments on commit f3b0080

Please sign in to comment.