Skip to content

[Do not merge] Python SDK: Add properties and methods - #2998

Open
ngrayluna wants to merge 5 commits into
mainfrom
sdk_add_methods_properties
Open

[Do not merge] Python SDK: Add properties and methods#2998
ngrayluna wants to merge 5 commits into
mainfrom
sdk_add_methods_properties

Conversation

@ngrayluna

@ngrayluna ngrayluna commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Description

[Do not merge]

Preview of docs. Styling updates include:

  • Separates property and methods into their own pages (i.e. no more long single Class page)
  • Mintlify badges
  • Adds "compact" to GitHub MDX component

See PR for all changes: ngrayluna/wandb-ref-and-biases#35

@wandb wandb deleted a comment from github-actions Bot Aug 1, 2026
@ngrayluna
ngrayluna marked this pull request as ready for review August 1, 2026 00:17
@ngrayluna
ngrayluna requested a review from a team as a code owner August 1, 2026 00:17
@ngrayluna ngrayluna added the DO-NOT-MERGE For PRs that should not be merged yet label Aug 1, 2026
@ngrayluna ngrayluna changed the title Python SDK: Add properties and methods [Do not merge] Python SDK: Add properties and methods Aug 1, 2026
@ngrayluna ngrayluna added DO-NOT-MERGE For PRs that should not be merged yet and removed DO-NOT-MERGE For PRs that should not be merged yet labels Aug 1, 2026
@mintlify

mintlify Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview Aug 1, 2026, 1:57 AM

@github-actions

github-actions Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

📚 Mintlify Preview Links

🔗 View Full Preview

✨ Added (49 total)

📄 Pages (49)

File Preview
models/ref/python/automations/newautomation/newautomation-properties.mdx Newautomation Properties
models/ref/python/automations/sendnotification/sendnotification-methods.mdx Sendnotification Methods
models/ref/python/automations/sendwebhook/sendwebhook-methods.mdx Sendwebhook Methods
models/ref/python/data-types/audio/audio-methods.mdx Audio Methods
models/ref/python/data-types/image/image-properties.mdx Image Properties
models/ref/python/data-types/molecule/molecule-methods.mdx Molecule Methods
models/ref/python/data-types/object3d/object3d-methods.mdx Object3d Methods
models/ref/python/data-types/table/table-methods.mdx Table Methods
models/ref/python/experiments/artifact/artifact-methods.mdx Artifact Methods
models/ref/python/experiments/artifact/artifact-properties.mdx Artifact Properties
... and 39 more files

📝 Changed (78 total)

📄 Pages (77)

File Preview
models/ref/python/automations/automation.mdx Automation
models/ref/python/automations/donothing.mdx Donothing
models/ref/python/automations/metricchangefilter.mdx Metricchangefilter
models/ref/python/automations/metricthresholdfilter.mdx Metricthresholdfilter
models/ref/python/automations/metriczscorefilter.mdx Metriczscorefilter
models/ref/python/automations/newautomation.mdx Newautomation
models/ref/python/automations/onaddartifactalias.mdx Onaddartifactalias
models/ref/python/automations/onaddartifacttag.mdx Onaddartifacttag
models/ref/python/automations/onaddcollectiontag.mdx Onaddcollectiontag
models/ref/python/automations/oncreateartifact.mdx Oncreateartifact
... and 67 more files
⚙️ Other (1)
File
docs.json

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 5501ef1 at 2026-08-04 02:43:25 UTC

@github-actions

github-actions Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Preview: https://wb-21fd5541-sdk-add-methods-properties.mintlify.site

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Readability impact

Word-weighted Flesch-Kincaid grade change across 49 changed pages: +0.2 (harder).

Lower Flesch-Kincaid grade and higher reading ease both mean easier to read. This check is informational and never blocks a PR.

Human readability

Page FK grade before FK grade after FK Δ Reading ease Δ Direction
models/ref/python/automations/automation.mdx 8.1 8.1 +0.0 +0.0 unchanged
models/ref/python/automations/donothing.mdx too little prose to score
models/ref/python/automations/metricchangefilter.mdx 8.1 8.1 +0.0 +0.0 unchanged
models/ref/python/automations/metricthresholdfilter.mdx too little prose to score
models/ref/python/automations/metriczscorefilter.mdx 6.1 6.1 +0.0 +0.0 unchanged
models/ref/python/automations/newautomation.mdx 8.4 9.1 +0.7 -6.0 harder
models/ref/python/automations/newautomation/newautomation-properties.mdx too little prose to score
models/ref/python/automations/onaddartifactalias.mdx 9.5 9.5 +0.0 +0.0 unchanged
models/ref/python/automations/onaddartifacttag.mdx 8.7 8.7 +0.0 +0.0 unchanged
models/ref/python/automations/onaddcollectiontag.mdx too little prose to score
models/ref/python/automations/oncreateartifact.mdx 9.3 9.3 +0.0 +0.0 unchanged
models/ref/python/automations/onlinkartifact.mdx 8.1 8.1 +0.0 +0.0 unchanged
models/ref/python/automations/onremoveartifacttag.mdx too little prose to score
models/ref/python/automations/onremovecollectiontag.mdx too little prose to score
models/ref/python/automations/onrunmetric.mdx 8.2 7.8 -0.4 +0.7 easier
models/ref/python/automations/onrunstate.mdx 5.1 4.7 -0.4 +1.4 easier
models/ref/python/automations/onunlinkartifact.mdx too little prose to score
models/ref/python/automations/runstatefilter.mdx too little prose to score
models/ref/python/automations/sendnotification.mdx 9.5 9.0 -0.5 +2.2 easier
models/ref/python/automations/sendnotification/sendnotification-methods.mdx too little prose to score
models/ref/python/automations/sendwebhook.mdx too little prose to score
models/ref/python/automations/sendwebhook/sendwebhook-methods.mdx too little prose to score
models/ref/python/custom-charts/bar.mdx 3.0 3.0 +0.0 +0.0 unchanged
models/ref/python/custom-charts/confusion_matrix.mdx 7.9 7.9 +0.0 +0.0 unchanged
models/ref/python/custom-charts/histogram.mdx 4.6 4.6 +0.0 +0.0 unchanged
models/ref/python/custom-charts/line.mdx 4.2 4.2 +0.0 +0.0 unchanged
models/ref/python/custom-charts/line_series.mdx 7.7 7.7 +0.0 +0.0 unchanged
models/ref/python/custom-charts/plot_table.mdx 8.2 8.2 +0.0 +0.0 unchanged
models/ref/python/custom-charts/pr_curve.mdx 7.7 7.7 +0.0 +0.0 unchanged
models/ref/python/custom-charts/roc_curve.mdx 4.6 4.6 +0.0 +0.0 unchanged
models/ref/python/custom-charts/scatter.mdx 3.5 3.5 +0.0 +0.0 unchanged
models/ref/python/data-types/audio.mdx too little prose to score
models/ref/python/data-types/audio/audio-methods.mdx too little prose to score
models/ref/python/data-types/histogram.mdx 6.4 6.4 +0.0 +0.0 unchanged
models/ref/python/data-types/html.mdx 2.9 2.9 +0.0 +0.0 unchanged
models/ref/python/data-types/image.mdx 7.0 7.0 +0.0 +0.0 unchanged
models/ref/python/data-types/image/image-properties.mdx too little prose to score
models/ref/python/data-types/molecule.mdx too little prose to score
models/ref/python/data-types/molecule/molecule-methods.mdx 10.6 n/a
models/ref/python/data-types/object3d.mdx too little prose to score
models/ref/python/data-types/object3d/object3d-methods.mdx 5.9 n/a
models/ref/python/data-types/plotly.mdx too little prose to score
models/ref/python/data-types/table.mdx 7.3 8.7 +1.4 -5.6 harder
models/ref/python/data-types/table/table-methods.mdx 5.9 n/a
models/ref/python/data-types/video.mdx 8.0 8.0 +0.0 +0.0 unchanged
models/ref/python/experiments/artifact.mdx 7.8 8.0 +0.2 -3.3 harder
models/ref/python/experiments/artifact/artifact-methods.mdx 7.7 n/a
models/ref/python/experiments/artifact/artifact-properties.mdx 7.4 n/a
models/ref/python/experiments/run.mdx 7.6 7.3 -0.3 -1.9 easier
models/ref/python/experiments/run/run-methods.mdx 7.8 n/a
models/ref/python/experiments/run/run-properties.mdx 6.5 n/a
models/ref/python/experiments/settings.mdx 7.2 7.5 +0.3 -1.7 harder
models/ref/python/experiments/settings/settings-methods.mdx too little prose to score
models/ref/python/experiments/settings/settings-properties.mdx 3.9 n/a
models/ref/python/functions/agent.mdx 6.5 6.5 +0.0 +0.0 unchanged
models/ref/python/functions/box3d.mdx 6.3 6.3 +0.0 +0.0 unchanged
models/ref/python/functions/controller.mdx too little prose to score
models/ref/python/functions/finish.mdx 7.6 7.6 +0.0 +0.0 unchanged
models/ref/python/functions/init.mdx 8.2 8.2 +0.0 +0.0 unchanged
models/ref/python/functions/login.mdx 8.6 8.6 +0.0 +0.0 unchanged
models/ref/python/functions/restore.mdx 5.4 5.4 +0.0 +0.0 unchanged
models/ref/python/functions/setup.mdx 10.9 10.9 +0.0 +0.0 unchanged
models/ref/python/functions/sweep.mdx 8.4 8.4 +0.0 +0.0 unchanged
models/ref/python/functions/teardown.mdx 8.0 8.0 +0.0 +0.0 unchanged
models/ref/python/public-api/api.mdx 7.7 5.3 -2.4 +15.5 easier
models/ref/python/public-api/api/api-methods.mdx 7.7 n/a
models/ref/python/public-api/api/api-properties.mdx too little prose to score
models/ref/python/public-api/artifactcollection.mdx too little prose to score
models/ref/python/public-api/artifactcollection/artifactcollection-methods.mdx 9.9 n/a
models/ref/python/public-api/artifactcollection/artifactcollection-properties.mdx 9.0 n/a
models/ref/python/public-api/artifactcollections.mdx too little prose to score
models/ref/python/public-api/artifactcollections/artifactcollections-methods.mdx too little prose to score
models/ref/python/public-api/artifactfiles.mdx too little prose to score
models/ref/python/public-api/artifactfiles/artifactfiles-methods.mdx too little prose to score
models/ref/python/public-api/artifactfiles/artifactfiles-properties.mdx too little prose to score
models/ref/python/public-api/artifacts.mdx too little prose to score
models/ref/python/public-api/artifacts/artifacts-methods.mdx too little prose to score
models/ref/python/public-api/artifacttype.mdx too little prose to score
models/ref/python/public-api/artifacttype/artifacttype-methods.mdx 8.4 n/a
models/ref/python/public-api/artifacttype/artifacttype-properties.mdx too little prose to score
models/ref/python/public-api/artifacttypes.mdx too little prose to score
models/ref/python/public-api/artifacttypes/artifacttypes-methods.mdx too little prose to score
models/ref/python/public-api/betareport.mdx 7.5 7.7 +0.2 -1.4 harder
models/ref/python/public-api/betareport/betareport-methods.mdx too little prose to score
models/ref/python/public-api/betareport/betareport-properties.mdx too little prose to score
models/ref/python/public-api/downloadhistoryresult.mdx 6.8 6.8 +0.0 +0.0 unchanged
models/ref/python/public-api/file.mdx 7.5 9.3 +1.8 -3.7 harder
models/ref/python/public-api/file/file-methods.mdx 6.4 n/a
models/ref/python/public-api/file/file-properties.mdx too little prose to score
models/ref/python/public-api/files.mdx 7.0 7.2 +0.2 +2.4 harder
models/ref/python/public-api/files/files-methods.mdx too little prose to score
models/ref/python/public-api/incompleterunhistoryerror.mdx too little prose to score
models/ref/python/public-api/incompleterunhistoryerror/incompleterunhistoryerror-methods.mdx too little prose to score
models/ref/python/public-api/member.mdx too little prose to score
models/ref/python/public-api/member/member-methods.mdx too little prose to score
models/ref/python/public-api/organization.mdx too little prose to score
models/ref/python/public-api/project.mdx too little prose to score
models/ref/python/public-api/project/project-methods.mdx 7.2 n/a
models/ref/python/public-api/project/project-properties.mdx too little prose to score
models/ref/python/public-api/projectartifactcollections.mdx too little prose to score
models/ref/python/public-api/projectartifactcollections/projectartifactcollections-methods.mdx too little prose to score
models/ref/python/public-api/projects.mdx 7.5 6.0 -1.5 +9.3 easier
models/ref/python/public-api/projects/projects-methods.mdx too little prose to score
models/ref/python/public-api/registry.mdx too little prose to score
models/ref/python/public-api/registry/registry-methods.mdx 7.2 n/a
models/ref/python/public-api/registry/registry-properties.mdx 7.6 n/a
models/ref/python/public-api/reports.mdx 6.5 5.1 -1.4 +10.1 easier
models/ref/python/public-api/reports/reports-methods.mdx too little prose to score
models/ref/python/public-api/run.mdx 7.0 11.1 +4.1 -17.4 harder
models/ref/python/public-api/run/run-methods.mdx 7.2 n/a
models/ref/python/public-api/run/run-properties.mdx 4.9 n/a
models/ref/python/public-api/runartifacts.mdx too little prose to score
models/ref/python/public-api/runartifacts/runartifacts-methods.mdx too little prose to score
models/ref/python/public-api/runs.mdx 7.5 6.0 -1.5 +6.4 easier
models/ref/python/public-api/runs/runs-methods.mdx 10.4 n/a
models/ref/python/public-api/sweep.mdx 5.1 5.8 +0.7 -2.4 harder
models/ref/python/public-api/sweep/sweep-methods.mdx 3.7 n/a
models/ref/python/public-api/sweep/sweep-properties.mdx 6.0 n/a
models/ref/python/public-api/sweeps.mdx 6.4 5.2 -1.2 +7.2 easier
models/ref/python/public-api/sweeps/sweeps-methods.mdx too little prose to score
models/ref/python/public-api/team.mdx 6.2 7.1 +0.9 -7.1 harder
models/ref/python/public-api/team/team-methods.mdx 6.6 n/a
models/ref/python/public-api/user.mdx too little prose to score
models/ref/python/public-api/user/user-methods.mdx 3.6 n/a
models/ref/python/public-api/user/user-properties.mdx 4.4 n/a
snippets/_includes/github-source-link.mdx too little prose to score

AI agent comprehension

Rated 0-3 (higher is easier for an agent to parse and act on).

Page Before After Δ
models/ref/python/public-api/api/api-methods.mdx
models/ref/python/experiments/run/run-methods.mdx
models/ref/python/experiments/settings.mdx
models/ref/python/experiments/artifact/artifact-methods.mdx
models/ref/python/functions/init.mdx
models/ref/python/public-api/run/run-methods.mdx
models/ref/python/experiments/artifact/artifact-properties.mdx
models/ref/python/public-api/registry/registry-methods.mdx
models/ref/python/experiments/run/run-properties.mdx
models/ref/python/data-types/table.mdx

Curated-docs baseline median FK grade by type: conceptual 10.5, procedural 8.8, reference 9.4.

From workflow run 30872508748

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DO-NOT-MERGE For PRs that should not be merged yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant