Skip to content

Commit

Permalink
Merge branch 'main' into DOCS-838
Browse files Browse the repository at this point in the history
  • Loading branch information
J2-D2-3PO authored Feb 6, 2025
2 parents 764f435 + ed0d198 commit 705ec6b
Show file tree
Hide file tree
Showing 43 changed files with 1,149 additions and 370 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ updates:
directory: "/"
schedule:
# Check for updates to GitHub Actions every weekday
interval: "daily"
interval: "daily"
8 changes: 1 addition & 7 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
{Short description}

{More details, or remove this line}
{Description of the change}

-- Remove this line and following from the merge commit message --

{JIRA / GitHub issue, or remove this line}
{Upstream code PR, or remove this line}

Confirm that tests pass and this change is ready for review:
- [ ] Local `hugo serve`
- [ ] Local `vale ./content`
4 changes: 2 additions & 2 deletions .github/workflows/check_header.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v4
uses: actions/setup-python@v5
with:
python-version: '3.10'

Expand Down
39 changes: 18 additions & 21 deletions .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
@@ -1,37 +1,34 @@
name: Lychee check
on:
pull_request:
paths:
- '**.md'
repository_dispatch:
workflow_dispatch:
schedule:
- cron: "5 0 1 * *" # In UTC, currently 12:05 AM on the 1st of each month

jobs:
lychee:
linkChecker:
runs-on: ubuntu-latest
permissions:
issues: write # required for peter-evans/create-issue-from-file
steps:
# check URLs with Lychee
- uses: actions/checkout@v4

- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45
with:
files: "**.md"

- name: Link Checker
id: lychee
uses: lycheeverse/lychee-action@v1.10.0
uses: lycheeverse/lychee-action@v2
with:
token: ${{ secrets.GITHUB_TOKEN }}
args: >
--scheme https --scheme http --verbose --no-cache
--user-agent "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"
--max-concurrency 5 --retry-count 3 --retry-delay 2
${{ steps.changed-files.outputs.all_changed_files }}
args: "--base content --accept 200,429 --user-agent 'Mozilla/5.0 (Windows NT 10.0; Win64; x64)' --scheme https --scheme http --max-concurrency 5 --max-retries 1 --retry-wait-time 2 --verbose --no-progress './**/*.md' './**/*.html'"
fail: false
env:
# to be used in case rate limits are surpassed
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

- name: Create PR comment with link reults
uses: marocchino/sticky-pull-request-comment@v2
- name: Create Issue From File
if: steps.lychee.outputs.exit_code != 0
uses: peter-evans/create-issue-from-file@v5
with:
header: lychee
recreate: true
path: ./lychee/out.md
title: Link Checker Report
content-filepath: ./lychee/out.md
labels: report, automated issue
Binary file added assets/images/reports/freeze_runset.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Use [W&B Models]({{< relref "/guides/" >}}) to manage all aspects of building yo
- [Introduction]({{< relref "/guides/" >}})
- [Quickstart]({{< relref "/guides/quickstart/" >}})
- [YouTube Tutorial](https://www.youtube.com/watch?v=tHAFujRhZLA)
- [Online Course](https://www.wandb.courses/courses/wandb-101)
- [Online Course](https://wandb.ai/site/courses/101/)

</div>{{% /card %}}
{{< /cardpane >}}
Expand Down
9 changes: 9 additions & 0 deletions content/guides/core/reports/edit-a-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,15 @@ report.save()
{{% /tab %}}
{{< /tabpane >}}


## Freeze a run set

A report automatically updates run sets to show the latest data from the project. You can preserve the run set in a report by *freezing* that run set. When you freeze a run set, you preserve the state of the run set in a report at a point in time.

To freeze a run set when viewing a report, click the snowflake icon in its panel grid near the **Filter** button.

{{< img src="/images/reports/freeze_runset.png" alt="" >}}

## Add code blocks

Add code blocks to your report interactively with the App UI or with the W&B SDK.
Expand Down
18 changes: 18 additions & 0 deletions content/guides/hosting/data-security/secure-storage-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,24 @@ Bring your own bucket (BYOB) allows you to store W&B artifacts and other related
* You can specify a sub-path when configuring a bucket, to ensure that W&B does not store any files in a folder at the root of the bucket. It can help you better conform to your organzation's bucket governance policy.
{{% /alert %}}

## Data stored in the central database vs buckets

When using BYOB functionality, certain types of data will be stored in the W&B central database, and other types will be stored in your bucket.

### Database

- Metadata for users, teams, artifacts, experiments, and projects
- Reports
- Experiment logs
- System metrics

## Buckets

- Experiment files and metrics
- Artifact files
- Media files
- Run files

## Configuration options
There are two scopes you can configure your storage bucket to: at the *Instance level* or at a *Team level*.

Expand Down
Loading

0 comments on commit 705ec6b

Please sign in to comment.