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

Use enable_deck=True in docs #5645

Merged
merged 2 commits into from
Aug 8, 2024
Merged

Use enable_deck=True in docs #5645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1d7a5c
Use enable_deck=True in docs
thomasjpfan Aug 8, 2024
37c983d
Apply suggestions from code review
eapolinario Aug 8, 2024
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
2 changes: 1 addition & 1 deletion docs/core_use_cases/analytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ of the map. In this case, we normalize the `people_vaccinated` by the
`population` count of each country:

```{code-cell} ipython3
@task(disable_deck=False)
@task(enable_deck=True)
def plot(df: pd.DataFrame):
"""Render a Choropleth map."""
df["text"] = df["location"] + "<br>" + "Last updated on: " + df["date"]
Expand Down
2 changes: 1 addition & 1 deletion docs/core_use_cases/machine_learning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ There are many ways to extend your workloads:
{ref}`Kubeflow Pytorch<kf-pytorch-op>` and {doc}`more <_tags/DistributedComputing>` to do distributed training.
* - **🔎 Experiment Tracking**
- Auto-capture training logs with the {py:func}`~flytekitplugins.mlflow.mlflow_autolog`
decorator, which can be viewed as Flyte Decks with `@task(disable_decks=False)`.
decorator, which can be viewed as Flyte Decks with `@task(enable_deck=True)`.
* - **⏩ Inference Acceleration**
- Serialize your models in ONNX format using the {ref}`ONNX plugin <onnx>`, which
supports ScikitLearn, TensorFlow, and PyTorch.
Expand Down
10 changes: 5 additions & 5 deletions docs/flyte_fundamentals/visualizing_task_input_and_output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ how to generate an HTML report from some Python object.

## Enabling Flyte decks

To enable Flyte decks, simply set `disable_deck=False` in the `@task` decorator:
To enable Flyte decks, simply set `enable_deck=True` in the `@task` decorator:

```{code-cell} ipython3
import pandas as pd
from flytekit import task, workflow


@task(disable_deck=False)
@task(enable_deck=True)
def iris_data() -> pd.DataFrame:
...
```
Expand All @@ -51,7 +51,7 @@ from typing import Optional
from flytekit import task, workflow


@task(disable_deck=False)
@task(enable_deck=True)
def iris_data(
sample_frac: Optional[float] = None,
random_state: Optional[int] = None,
Expand Down Expand Up @@ -168,7 +168,7 @@ function. In the following example, we extend the `iris_data` task with:
import flytekit
from flytekitplugins.deck.renderer import MarkdownRenderer, BoxRenderer

@task(disable_deck=False)
@task(enable_deck=True)
def iris_data(
sample_frac: Optional[float] = None,
random_state: Optional[int] = None,
Expand Down Expand Up @@ -220,7 +220,7 @@ except ImportError:
from typing_extensions import Annotated


@task(disable_deck=False)
@task(enable_deck=True)
def iris_data(
sample_frac: Optional[float] = None,
random_state: Optional[int] = None,
Expand Down
Loading