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.

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

User functions guide #252

Open
wants to merge 21 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 1 addition & 3 deletions dff/pipeline/pipeline/actor.py
Original file line number Diff line number Diff line change
Expand Up @@ -390,9 +390,7 @@ def validate_script(self, pipeline: Pipeline, verbose: bool = True):
return error_msgs


def default_condition_handler(
condition: Callable, ctx: Context, pipeline: Pipeline, *args, **kwargs
) -> Callable[[Context, Pipeline, Any, Any], bool]:
def default_condition_handler(condition: Callable, ctx: Context, pipeline: Pipeline, *args, **kwargs) -> bool:
"""
The simplest and quickest condition handler for trivial condition handling returns the callable condition:

Expand Down
14 changes: 10 additions & 4 deletions docs/source/user_guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@ for exploring the telemetry data collected from your conversational services.
We show how to plug in the telemetry collection and configure the pre-built
Superset dashboard shipped with DFF.

:doc:`User defined functions guide <./user_guides/user_functions>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``user defined functions guide`` tutorial describes useage of all user-defined functions
that can be used for framework extension.
For each of these functions use cases are defined, execution orser is specified
and also signature and return value types are highlighted.

:doc:`Optimization guide <./user_guides/optimization_guide>`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -32,8 +40,6 @@ and to locate and remove performance bottlenecks.

.. toctree::
:hidden:
:glob:

user_guides/basic_conceptions
user_guides/context_guide
user_guides/superset_guide
user_guides/optimization_guide
user_guides/*
Loading