scaffold.wandb.helpers
======================

.. py:module:: scaffold.wandb.helpers


Attributes
----------

.. autoapisummary::

   scaffold.wandb.helpers.WANDB_KEY
   scaffold.wandb.helpers.WANDB_SECRET
   scaffold.wandb.helpers.logger


Functions
---------

.. autoapisummary::

   scaffold.wandb.helpers.wandb_environment_setup


Module Contents
---------------

.. py:function:: wandb_environment_setup(username: str) -> None

   Retrieve wandb login secrets secrets and export them as environment variables.
   This is a convenience function for our Flyte setup to be called before `wandb.init()`.

   If this function is called in local setup, i.e. outside of flyte task context, it will not do anything.

   :param username: WandB user handle for look up of API key
   :type username: str


.. py:data:: WANDB_KEY
   :value: 'key_map'


.. py:data:: WANDB_SECRET
   :value: 'wandb-access-secret'


.. py:data:: logger