Skip to content

[Do not merge] Lazydocs: Preview Actions, Data Types, and Import & Export API #1213

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

Closed
wants to merge 1 commit into from

Conversation

ngrayluna
Copy link
Contributor

@ngrayluna ngrayluna commented Mar 25, 2025

Description

Preview of current API Docs using lazydocs. This PR shows the current state of the API docs. It includes APIs from:

  • wandb
    • Source: wandb/wandb/__init__.pyi
    • Where to find in docs preview:
      • /ref/python-library/actions/
      • /ref/python-library/data_types/
  • wandb.apis.public:
    • Source: wandb/wandb/apis/public/__init__.py
    • Where to find in docs preview: /ref/python-library/client_types/
Screen.Recording.2025-03-24.at.9.20.49.PM.mov

Files generated using ngrayluna/generate-wandb-python-reference.

wandb/wandb PRs

@ngrayluna ngrayluna added WIP DO-NOT-MERGE For PRs that should not be merged yet labels Mar 25, 2025
@ngrayluna ngrayluna requested a review from a team as a code owner March 25, 2025 04:16
@ngrayluna
Copy link
Contributor Author

ngrayluna commented Mar 25, 2025

To Do

  • Decide subdirectory naming. Current mapping from current public docs and this docs PR
    {
       "Data Types" :  "Data Types", 
       "Import & Export API" :  "Client Types"
    }
    
    There is also a new subdirectory called "Actions". Logic used to sort APIs includes using the filepath obtained from
    getattr(module, api)
  • Sync with SDK Team on which properties, attributes, methods, etc. that are shown in the Import & Export API section (currently called /ref/python-library/client_types/). Create PR with edits.
  • Investigate why these are missing from wandb/__init__.pyi: "ArtifactTTL", "Settings", "summary", and "config"

@ngrayluna
Copy link
Contributor Author

Clsing in favor of #1239

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 WIP
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant