# 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`](https://www.union.ai/docs/v1/flyte/api-reference/plugins/wandb/packages/flytekitplugins.wandb/page.md#flytekitpluginswandbwandb_init) |  |

## flytekitplugins.wandb.wandb_init

### Parameters

```python
class wandb_init(
    task_function: typing.Optional[typing.Callable],
    project: typing.Optional[str],
    entity: typing.Optional[str],
    secret: typing.Union[flytekit.models.security.Secret, typing.Callable, NoneType],
    id: typing.Optional[str],
    host: str,
    api_host: str,
    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()`](#execute) | This method will be called when the decorated function is called. |
| [`get_extra_config()`](#get_extra_config) | Get the config of the decorator. |

#### execute()

```python
def execute(
    args,
    kwargs,
)
```
This method will be called when the decorated function is called.

| Parameter | Type | Description |
|-|-|-|
| `args` | `*args` | |
| `kwargs` | `**kwargs` | |

#### get_extra_config()

```python
def get_extra_config()
```
Get the config of the decorator.

---
**Source**: https://github.com/unionai/unionai-docs/blob/main/content/api-reference/plugins/wandb/packages/flytekitplugins.wandb.md
**HTML**: https://www.union.ai/docs/v1/flyte/api-reference/plugins/wandb/packages/flytekitplugins.wandb/