Skip to content

Publish Server release notes in the docs #1048

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

Merged
merged 36 commits into from
Apr 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
2e2f132
initial checkin
johndmulhausen Jan 30, 2025
7d9c8a8
Merge branch 'main' into release-notes-to-hugo
johndmulhausen Apr 10, 2025
2b1ac03
Fixes, navigation exposure
johndmulhausen Apr 10, 2025
d7cb409
Simplify page titles and frontmatter, remove dates from URLs
mdlinville Apr 11, 2025
a80a65e
Move EOL releases to archive
mdlinville Apr 11, 2025
301698b
Use run.log(), not wandb.log() (#1203)
travis-the-dragon Apr 10, 2025
7d051f4
Repurpose server release process page for release policies
mdlinville Apr 11, 2025
6e811fa
Merge remote-tracking branch 'origin/main' into release-notes-to-hugo
mdlinville Apr 11, 2025
248d9f6
Try to fix individual RN pages downloading as text instead of loading…
mdlinville Apr 11, 2025
be31f67
Actually remove old page, adjust weight of Release Policies
mdlinville Apr 11, 2025
9183a87
Copyedits to release notes
mdlinville Apr 11, 2025
0ead44e
Merge branch 'main' into release-notes-to-hugo
mdlinville Apr 14, 2025
39e651c
Merge remote-tracking branch 'origin/main' into release-notes-to-hugo
mdlinville Apr 18, 2025
44f42d4
Adjustments
mdlinville Apr 18, 2025
eb47c13
Merge branch 'main' into release-notes-to-hugo
mdlinville Apr 18, 2025
1b18cdd
Merge branch 'main' into release-notes-to-hugo
mdlinville Apr 21, 2025
86d0851
Merge remote-tracking branch 'origin/main' into release-notes-to-hugo
mdlinville Apr 22, 2025
4081362
Add RSS subscription button
mdlinville Apr 22, 2025
c746605
Add link from releases index to archived releases
mdlinville Apr 22, 2025
8c49a56
Merge remote-tracking branch 'origin/main' into release-notes-to-hugo
mdlinville Apr 24, 2025
a2d4cfd
Merge remote-tracking branch 'origin/main' into release-notes-to-hugo
mdlinville Apr 25, 2025
74f60e1
0.68 draft for testing
mdlinville Apr 25, 2025
bbad4fd
Show future posts
johndmulhausen Apr 25, 2025
c5f3fe7
URL fixes
johndmulhausen Apr 25, 2025
82711e5
Merge remote-tracking branch 'origin/main' into release-notes-to-hugo
mdlinville Apr 25, 2025
25b8697
Fix broken links, other minor adjustments
mdlinville Apr 26, 2025
e3102ff
Move release notes under /ref
johndmulhausen Apr 28, 2025
6477aae
Fix for archived
johndmulhausen Apr 28, 2025
7e7cb75
title -> filename
johndmulhausen Apr 28, 2025
79d4dff
Fixes to index metadata
mdlinville Apr 28, 2025
4a253fb
Merge remote-tracking branch 'origin/release-notes-to-hugo' into rele…
mdlinville Apr 28, 2025
83a26be
0.68 draft updates
mdlinville Apr 28, 2025
fdb6ef7
Merge branch 'main' into release-notes-to-hugo
mdlinville Apr 28, 2025
305fdff
Add card panes to reference landing page
mdlinville Apr 28, 2025
52750f2
Fix broken links
mdlinville Apr 29, 2025
281ebf8
Add note for sparse metrics fix
mdlinville Apr 29, 2025
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: 3 additions & 1 deletion .lycheeignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,6 @@ https://docs.wandb.ai/ref/weave/entity
https://www.wandb.ai/authorize
https://x.com/weights_biases
https://auth0.com/docs/get-started/

https://wiki.python.org/moin/UsingPickle
https://docs.wandb.ai/ja/support/
https://docs.wandb.ai/ko/support/
44 changes: 0 additions & 44 deletions content/guides/hosting/server-release-process.md

This file was deleted.

2 changes: 1 addition & 1 deletion content/launch/set-up-launch/setup-agent-advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ artifactregistry.repositories.uploadArtifacts;
{{% /tab %}}
{{% tab "Azure" %}}

Add the [`AcrPush` role](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-roles?tabs=azure-cli#acrpush) if you use the Kaniko builder.
Add the [`AcrPush` role](https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles/containers#acrpush) if you use the Kaniko builder.
{{% /tab %}}
{{< /tabpane >}}

Expand Down
15 changes: 14 additions & 1 deletion content/ref/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,20 @@ cascade:
no_list: true
---


{{< cardpane >}}
{{< card >}}
<a href="./release-notes/releases/">
<h2 className="card-title">Release notes</h2>
</a>
<p className="card-content">Learn about W&B releases, including new features, performance improvements, and bug fixes.</p>
{{< /card >}}
{{< card >}}
<a href="./release-notes/release-policies/">
<h2 className="card-title">Release policies and processes</h2>
</a>
<p className="card-content">Learn more about W&B releases, including frequency, support policies, and end of life.</p>
{{< /card >}}
{{< /cardpane >}}

{{< cardpane >}}
{{< card >}}
Expand Down
4 changes: 2 additions & 2 deletions content/ref/python/public-api/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Most common way to initialize

| Args | |
| :--- | :--- |
| `overrides` | (dict) You can set `base_url` if you are using a wandb server other than https://api.wandb.ai. You can also set defaults for `entity`, `project`, and `run`. |
| `overrides` | (dict) You can set `base_url` if you are using a wandb server other than `https://api.wandb.ai`. You can also set defaults for `entity`, `project`, and `run`. |

| Attributes | |
| :--- | :--- |
Expand Down Expand Up @@ -980,7 +980,7 @@ api = wandb.Api()
webhook_integrations = api.webhook_integrations(entity="my-team")
```

Find only webhook integrations that post requests to "https://my-fake-url.com":
Find only webhook integrations that post requests to `https://my-fake-url.com`:

```python
webhook_integrations = api.webhook_integrations(entity="my-team")
Expand Down
19 changes: 19 additions & 0 deletions content/ref/release-notes/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Release Notes
type: docs
url: /ref/release-notes/releases/
cascade:
- url: /ref/release-notes/:filename/
- type: docs
- weight: 1
menu:
default:
parent: reference
identifier: release-notes
weight: 5
---

This section includes release notes for supported W&B Server releases. For releases that are no longer supported, refer to [Archived releases]({{< relref "archived/" >}}).

<a href="/release-notes/releases/index.xml"><button class="btn btn-primary mb-4 feedback--answer"><i class="fa-sharp fa-regular fa-square-rss" alt="RSS icon"></i>&nbsp;RSS feed</button></a>

63 changes: 63 additions & 0 deletions content/ref/release-notes/release-policies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
description: Release process for W&B Server
menu:
default:
identifier: server-release-process
parent: w-b-platform
title: Release policies and processes
weight: -1
---
This page gives details about W&B Server releases and W&B's release policies. This page relates to [W&B Dedicated Cloud]({{< relref "/guides/hosting/hosting-options/dedicated_cloud/" >}}) and [Self-Managed]({{< relref "/guides/hosting/hosting-options/self-managed/" >}}) deployments. To learn more about an individual W&B Server release, refer to [W&B release notes]({{< relref "/ref/release-notes/" >}}).

W&B fully manages [W&B Multi-tenant Cloud]({{< relref "/guides/hosting/hosting-options/saas_cloud.md" >}}) and the details in this page do not apply.

## Release support and end of life policy
W&B supports a major W&B Server release for 6 months from its initial release date.
- **Dedicated Cloud** instances are automatically updated to maintain support.
- Customers with **Self-managed** instances are responsible for upgrading in time to maintain support. Avoid staying on an unsupported version.

{{% alert %}}
W&B strongly recommends customers with **Self-managed** instances to update their deployments with the latest release at minimum once per quarter to maintain support and receive the latest features, performance improvements, and fixes.
{{% /alert %}}

## Release types and frequencies
- **Major releases** are produced monthly, and may include new features, enhancements, performance improvements, medium and low severity bug fixes, and deprecations. An example of a major release is `0.68.0`.
- **Patch releases** within a major version are produced as needed, and include critical and high severity bug fixes. An example of a patch release is `0.67.1`.

## Release rollout
1. After testing and validation are complete, a release is first rolled out to all **Dedicated Cloud** instances to keep them fully updated.
1. After additional observation, the release is published, and **Self-managed** deployments can upgrade to it on their own schedule, and are responsible for upgrading in time to comply with the [Release support and End of Life (EOL) policy]({{< relref "#release-support-and-end-of-life-policy" >}}). Learn more about [upgrading W&B Server]({{< relref "/guides/hosting/hosting-options/self-managed/server-upgrade-process.md" >}}).

## Downtime during upgrades
- When a **Dedicated Cloud** instance is upgraded, downtime is generally not expected, but may occur in certain situations:
- If a new feature or enhancement requires changes to the underlying infrastructure, such as compute, storage or network.
- To roll out a critical infrastructure change such as a security fix.
- If the instance's current version has reached its [End of Life (EOL)]({{< relref "/guides/hosting/hosting-options/self-managed/server-upgrade-process.md" >}}) and is upgraded by W&B to maintain support.
- For **Self-managed** deployments, the customer is responsible for implementing a rolling update process that meets their service level objectives (SLOs), such as by [running W&B Server on Kubernetes]({{< relref "/guides/hosting/hosting-options/self-managed/kubernetes-operator/" >}}).

## Feature availability
After installing or upgrading, certain features may not be immediately available.

### Enterprise features
An Enterprise license includes support for important security capabilities and other enterprise-friendly functionality. Some advanced features require an Enterprise license.

- **Dedicated Cloud** includes an Enterprise license and no action is required.
- On **Self-managed** deployments, features that require an Enterprise license are not available until it is set. To learn more or obtain an Enterprise license, refer to [Obtain your W&B Server license]({{< relref "/guides/hosting/hosting-options/self-managed.md#obtain-your-wb-server-license" >}}).

### Private preview and opt-in features
Most features are available immediately after installing or upgrading W&B Server. The W&B team must enable certain features before you can use them in your instance.

{{% alert color="warning" %}}
Any feature in a preview phase is subject to change. A preview feature is not guaranteed to become generally available.
{{% /alert %}}

- **Private preview**: W&B invites design partners and early adopters to test these features and provide feedback. Private preview features are not recommended for production environments.

The W&B team must enable a private preview feature for your instance before you can use it. Public documentation is not available; instructions are provided directly. Interfaces and APIs may change, and the feature may not be fully implemented.
- **Public preview**: Contact W&B to opt in to a public preview to try it out before it is generally available.

The W&B team must enable a public preview feature before you can use it in your instance. Documentation may not be complete, interfaces and APIs may change, and the feature may not be fully implemented.

To learn more about an individual W&B Server release, including any limitations, refer to [W&B Release notes]({{< relref "/ref/release-notes/" >}}).


25 changes: 25 additions & 0 deletions content/ref/release-notes/releases/0.63.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "0.63.0"
date: 2024-12-10
description: "December 10, 2024"
---

## Features

**[Weave](https://wandb.ai/site/weave/) is now generally available (GA) in Dedicated Cloud on AWS. Reach out to your W&B team if your teams are looking to build Generative AI apps with confidence and putting those in production.**

<img width="877" alt="Image showing the Weave UI" src="https://github.com/user-attachments/assets/22786cbc-7d69-4505-b329-78cb87734d19">

The release includes the following additional updates:

* W&B Models now seamlessly integrates with **_Azure public cloud_**. You could now create a Dedicated Cloud instance in an Azure region directly from your Azure subscription and manage it as an Azure ISV resource. [This integration is in private preview](https://wandb.ai/site/partners/azure).
* Enable automations at the Registry level to monitor changes and events across all collections in the registry and trigger actions accordingly. This eliminates the need to configure separate webhooks and automations for individual collections.
* Ability to assign x_label, e.g. node-0, in run settings object to distinguish logs and metrics by label, e.g. node, in distributed runs. Enables grouping system metrics and console logs by label for visualization in the workspace.
* **_Coming soon_** with a patch release this week, you will be able to use organization-level service accounts to automate your W&B workloads across all teams in your instance. You would still be able to use existing team-level service accounts if you would like more control over the access scope of a service account.
* Allow org-level service accounts to interact with Registry. Such service accounts can be invited to a registry using the invite modal and are displayed in the members table along with respective organization roles.

## Fixes

* Fixed an issue where users creating custom roles including the `Create Artifact` permission were not able to log artifacts to a project.
* Fixed the issue with metadata logging for files in instances that have subpath support configured for BYOB.
* Block webhook deletion if used by organization registry automations.
14 changes: 14 additions & 0 deletions content/ref/release-notes/releases/0.65.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "0.65.0"
date: 2025-01-30
description: "January 30, 2025"
---

## Features
- From a registry's **Settings**, you can now update the owner to a different user with the Admin role. Select **Owner** from the user's **Role** menu.
- You can now move a run to a different group in the same project. Hover over a run in the run list, click the three-vertical-dots menu, and choose **Move to another group**.
- You can now configure whether the **Log Scale setting** for line plots is enabled by default at the level of the workspace or section.
- To configure the behavior for a workspace, click the action `...` menu for the workspace, click **Line plots**, then toggle **Log scale** for the X or Y axis.
- To configure the behavior for a section, click the gear icon for the section, then toggle **Log scale** for the X or Y axis.


12 changes: 12 additions & 0 deletions content/ref/release-notes/releases/0.66.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "0.66.0"
date: 2025-03-06
description: "March 06, 2025"
---

## Features
- In tables and query panels, columns you derive from other columns now persist, so you can use them for filtering or in query panel plots.

## Security
- Limited the maximum depth for a GraphQL document to 20.
- Upgraded pyarrow to v17.0.0.
Loading