Skip to content

Conversation

@ngrayluna
Copy link
Contributor

@ngrayluna ngrayluna commented Nov 21, 2025

Description

Adds table of optional Python SDK dependencies (i.e. "extras"). Note that some are excluded per recommendation of Eng and SDK Team.

Note: There doesn't exist a PEP standard for documenting Python package extras. The closest I could find was this proposal: https://peps.python.org/pep-0771/

List taken from: https://github.com/wandb/wandb/blob/main/pyproject.toml#L61

How it works

  1. Comment markers are added to models/ref/python.mdx:
{/* python-extras-start */}
{/* python-extras-start */}
  1. GH action in wandb/ triggers action (runs python generate_sdk_extras_table.py) in wandb/docs.
  2. This script outputs table between two markers specified in Step 1.

GH Action trigger PR

See this PR for workflow added to wandb/wandb that triggers when pyproject.toml file is edited: wandb/wandb#10976

Callout for reviewers

My GH Action writing skills are OK. TL;DR I used Claude Code to write the workflow files in wandb/ and wandb/docs.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 21, 2025

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (1 total)

📄 Pages (1)

File Preview
models/ref/python.mdx Python

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 7e9c8df at 2025-11-26 21:18:08 UTC

| `sweeps`| Manage sweeps. | [sweeps](https://pypi.org/project/sweeps/) |
| `launch` | Installs cloud providers and orchestration platforms | [awscli](https://pypi.org/project/awscli/), [azure-identity](https://pypi.org/project/azure-identity/), [azure-containerregistry](https://pypi.org/project/azure-containerregistry/), and more |
| `models`| | [cloudpickle](https://pypi.org/project/cloudpickle/) |
| `perf` | High-performance JSON serializer. | [orjson](https://pypi.org/project/orjson/) |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're trying hard to make orjson a requirement, so this will go away soon. It doesn't depend on us, unfortunately: ijl/orjson#607

Suggested change
| `perf` | High-performance JSON serializer. | [orjson](https://pypi.org/project/orjson/) |


Use extras when you need deeper integration with specific platforms or features. For example:

* Install `gcp` if you store datasets, models, or artifacts in Google Cloud Storage.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move, make h3 headings. Explain what "dependency" means.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants