shivance / wandb-addons

Weights & Biases Addons is a repository consisting of additional unitilities and community contributions for supercharging your Weights & Biases workflows.

🐝 Weights & Biases Addons

Weights & Biases Addons is a repository that provides of integrations and utilities that will supercharge your Weights & Biases workflows. Its a repositpry built and maintained by wandb users for wandb users.

Integrations

TensorFlow Datasets

A set of utilities for easily accessing datasets for various machine learning tasks using Weights & Biases artifacts built on top of TensorFlow Datasets.

In order to install wandb-addons along with the dependencies for the dataset utilities, you can run:

git clone https://github.com/soumik12345/wandb-addons
pip install ./wandb-addons[dataset]

• WandbDatasetBuilder: An abstract class for Dataset builder that enables building a dataset and upload it as a Weights & Biases Artifact.

• upload_dataset: Upload and register a dataset with a TFDS module or a TFDS builder script as a Weights & Biases artifact. This function would verify if a TFDS build/registration is possible with the current specified dataset path and upload it as a Weights & Biases artifact.

• load_dataset: Load a dataset from a wandb artifact. Using this function you can load a dataset hosted as a wandb artifact in a single line of code, and use our powerful data processing methods to quickly get your dataset ready for training in a deep learning model.

🌀 Ciclo

Functional callbacks for experiment tracking on Weights & Biases with Ciclo.

In order to install wandb-addons along with the dependencies for the ciclo callbacks, you can run:

git clone https://github.com/soumik12345/wandb-addons
pip install ./wandb-addons[jax]

Once you've installed wandb-addons, you can import it using:

from wandb_addons.ciclo import WandbLogger

For more information, check out more at the docs.

MonAI

Event handlers for experiment tracking on Weights & Biases with MonAI Engine for deep learning in healthcare imaging.

In order to install wandb-addons along with the dependencies for the ciclo callbacks, you can run:

git clone https://github.com/soumik12345/wandb-addons
pip install ./wandb-addons[monai]

Once you've installed wandb-addons, you can import it using:

from wandb_addons.monai import WandbStatsHandler, WandbModelCheckpointHandler

For more information, check out more at the docs.

Ultralytics

Callback for logging model checkpoint, predictions, and ground-truth annotations with interactive overlays for bounding boxes to Weights & Biases Tables during training, validation, and prediction for an ultratytics workflow using the YOLO models.

In order to install wandb-addons along with the dependencies for the ultralytics integration, you can run:

git clone https://github.com/soumik12345/wandb-addons
pip install ./wandb-addons[yolo]

Once you've installed wandb-addons, you can use it like following:

from ultralytics.yolo.engine.model import YOLO

import wandb
from wandb_addons.ultralytics import add_wandb_callback

# initialize wandb run
wandb.init(project="YOLOv8")

# initialize YOLO model
model = YOLO("yolov8n.pt")

# add wandb callback
add_wandb_callback(model)

# train
model.train(
    data="coco128.yaml",
    epochs=2,
    imgsz=640,
)

# validate
model.val()

# perform inference
model(['img1.jpeg', 'img2.jpeg'])

For more information, check out more at the docs.

Converting IPython Notebooks to Reports

A set of utilities to convert an IPython notebook to a Weights & Biases report.

Simply install wandb-addons using

git clone https://github.com/soumik12345/wandb-addons
pip install ./wandb-addons

You can convert your notebook to a report using the CLI:

nb2report \
    --filepath Use_WandbMetricLogger_in_your_Keras_workflow.ipynb \
    --wandb_project report-to-notebook \
    --wandb_entity geekyrakshit \
    --report_title "Use WandbMetricLogger in your Keras Workflow" \
    --description "A guide to using the WandbMetricLogger callback in your Keras and TensorFlow training worflow" \
    --width "readable"

Alternatively, you can also use the Python function:

from wandb_addons.report import convert_to_wandb_report

convert_to_wandb_report(
    filepath="./Use_WandbMetricLogger_in_your_Keras_workflow.ipynb",
    wandb_project="report-to-notebook",
    wandb_entity="geekyrakshit",
    report_title="Use WandbMetricLogger in your Keras Workflow",
    description="A guide to using the WandbMetricLogger callback in your Keras and TensorFlow training worflow"
)

For more information, check out more at the docs.

Trace

A high level API for Tracing your LLMs workflows with Weights & Biases Prompts.

You can use the Trace class to create objects that can be logged as a WBTraceTree media type. For a more detailed walkthrough please look at the quickstart tutorial in the examples directory

Status

wandb-addons is still in early development, the API for integrations and utilities is subject to change, expect things to break. If you are interested in contributing, please feel free to open an issue and/or raise a pull request.