Skip to content

Commit

Permalink
Use enable_deck=True in docs (flyteorg#5645)
Browse files Browse the repository at this point in the history
Signed-off-by: Bugra Gedik <[email protected]>
  • Loading branch information
thomasjpfan authored and bgedik committed Aug 15, 2024
1 parent ee724b1 commit a9beb65
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/core_use_cases/analytics.md
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
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
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

0 comments on commit a9beb65

Please sign in to comment.