1.16.28
flytekitplugins.wandb
.. currentmodule:: flytekitplugins.wandb
This package contains things that are useful when extending Flytekit.
.. autosummary:: :template: custom.rst :toctree: generated/
wandb_init
Directory
Classes
| Class | Description |
|---|---|
wandb_init |
flytekitplugins.wandb.wandb_init
Parameters
class wandb_init(
task_function: typing.Optional[typing.Callable] = None,
project: typing.Optional[str] = None,
entity: typing.Optional[str] = None,
secret: typing.Union[flytekit.models.security.Secret, typing.Callable, NoneType] = None,
id: typing.Optional[str] = None,
host: str = 'https://wandb.ai',
api_host: str = 'https://api.wandb.ai',
**init_kwargs: dict,
)Weights and Biases plugin.
| Parameter | Type | Description |
|---|---|---|
task_function |
typing.Optional[typing.Callable] |
The user function to be decorated. Defaults to None. |
project |
typing.Optional[str] |
The name of the project where you’re sending the new run. (Required) |
entity |
typing.Optional[str] |
An entity is a username or team name where you’re sending runs. (Required) |
secret |
typing.Union[flytekit.models.security.Secret, typing.Callable, NoneType] |
Secret with your WANDB_API_KEY or a callable that returns the API key. The callable takes no arguments and returns a string. (Required) |
id |
typing.Optional[str] |
A unique id for this wandb run. |
host |
str |
URL to your wandb service. The default is “ https://wandb.ai”. |
api_host |
str |
URL to your API Host, The default is “ https://api.wandb.ai”. |
**init_kwargs |
dict |
Methods
| Method | Description |
|---|---|
execute() |
This method will be called when the decorated function is called. |
get_extra_config() |
Get the config of the decorator. |
execute()
def execute(
*args,
**kwargs,
)This method will be called when the decorated function is called.
| Parameter | Type | Description |
|---|---|---|
*args |
||
**kwargs |
get_extra_config()
def get_extra_config()Get the config of the decorator.