Skip to content

Commit

Permalink
Finalize examples/pipefunc.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
basnijholt committed Jan 27, 2025
1 parent 7f48f26 commit b4d4d76
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 13 deletions.
18 changes: 6 additions & 12 deletions examples/pipefunc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ chapters:
f(a=1, b=2) # returns 3
f.func # is the original function
pipeline = Pipeline([f])
pipeline = Pipeline([...])
pipeline.info() # returns:
# {'inputs': ('a', 'b', 'x'), 'outputs': ('e',), 'intermediate_outputs': ('c', 'd'),
# 'required_inputs': ('a', 'b'), 'optional_inputs': ('x',)}
Expand Down Expand Up @@ -287,7 +287,7 @@ chapters:
- description: |
Another useful method is [bold blue]pipeline.info()[/] which returns information about the pipeline.
Or call [bold blue]pipeline.info(print_table=True)[/] to print a pretty table.
Also check [bold blue]pipeline.defaults()[/] and or any of the 20+ other methods/properties.
Also check [bold blue]pipeline.defaults[/] and or any of the 20+ other methods/properties.
focus:
- type: line_containing
pattern: pipeline =
Expand Down Expand Up @@ -697,14 +697,8 @@ chapters:
- title: "What's next?"
code: |
These were the basics of pipefunc.
Let's continue with the tutorial on pipefunc.readthedocs.io:
Run the tutorial locally with:
```bash
# Start tutorial:
uvx --with "pipefunc[docs]" opennb pipefunc/pipefunc/example.ipynb
pixi x -s pipefunc-extras -s opennb pipefunc/pipefunc/example.ipynb
```
Let's continue with the tutorial on pipefunc.readthedocs.io.
If time permits, look at:
* Physics based example (`physics-simulation.ipynb`)
* Type checking (`type-checking.ipynb`)
Expand All @@ -727,13 +721,13 @@ chapters:
- type: markdown
- description: |
Or run the main tutorial locally with:
[bold blue]uvx --with "pipefunc[docs]" opennb pipefunc/pipefunc/example.ipynb[/]
[bold blue]uvx --with "pipefunc\[docs]" opennb pipefunc/pipefunc/example.ipynb[/]
[bold blue]pixi x -s pipefunc-extras -s opennb pipefunc/pipefunc/example.ipynb[/]
focus:
- type: markdown
- description: |
Or run some of the documentation pages like:
[bold blue]uvx --with "pipefunc[docs]" opennb pipefunc/pipefunc/docs/source/examples/physics-simulation.md[/]
[bold blue]uvx --with "pipefunc\[docs]" opennb pipefunc/pipefunc/docs/source/examples/physics-simulation.md[/]
[bold blue]pixi x -s pipefunc-extras -s opennb pipefunc/pipefunc/docs/source/examples/physics-simulation.md[/]
focus:
- type: markdown
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b4d4d76

Please sign in to comment.