Skip to content

style: apply /style-guide pass to models/integrations#2673

Open
johndmulhausen wants to merge 3 commits into
mainfrom
style-guide/models-integrations-20260527-015516
Open

style: apply /style-guide pass to models/integrations#2673
johndmulhausen wants to merge 3 commits into
mainfrom
style-guide/models-integrations-20260527-015516

Conversation

@johndmulhausen
Copy link
Copy Markdown
Contributor

@johndmulhausen johndmulhausen commented May 27, 2026

Summary

This PR applies the /style-guide skill (Google Developer Style Guide + CoreWeave conventions) to 52 files under models/integrations. The run was automated; only style, terminology, voice, and formatting were changed — no technical content was added or modified.

Files edited

  • models/integrations/accelerate.mdx
  • models/integrations/add-wandb-to-any-library.mdx
  • models/integrations/autotrain.mdx
  • models/integrations/azure-openai-fine-tuning.mdx
  • models/integrations/catalyst.mdx
  • models/integrations/cohere-fine-tuning.mdx
  • models/integrations/composer.mdx
  • models/integrations/dagster.mdx
  • models/integrations/databricks.mdx
  • models/integrations/deepchecks.mdx
  • models/integrations/deepchem.mdx
  • models/integrations/diffusers.mdx
  • models/integrations/docker.mdx
  • models/integrations/dspy.mdx
  • models/integrations/farama-gymnasium.mdx
  • models/integrations/fastai.mdx
  • models/integrations/fastai/v1.mdx
  • models/integrations/huggingface.mdx
  • models/integrations/huggingface_transformers.mdx
  • models/integrations/hydra.mdx
  • models/integrations/ignite.mdx
  • models/integrations/keras.mdx
  • models/integrations/kubeflow-pipelines-kfp.mdx
  • models/integrations/lightgbm.mdx
  • models/integrations/lightning.mdx
  • models/integrations/metaflow.mdx
  • models/integrations/mmengine.mdx
  • models/integrations/mmf.mdx
  • models/integrations/nim.mdx
  • models/integrations/openai-api.mdx
  • models/integrations/openai-fine-tuning.mdx
  • models/integrations/openai-gym.mdx
  • models/integrations/paddledetection.mdx
  • models/integrations/paddleocr.mdx
  • models/integrations/prodigy.mdx
  • models/integrations/pytorch-geometric.mdx
  • models/integrations/pytorch.mdx
  • models/integrations/ray-tune.mdx
  • models/integrations/sagemaker.mdx
  • models/integrations/scikit.mdx
  • models/integrations/simpletransformers.mdx
  • models/integrations/skorch.mdx
  • models/integrations/spacy.mdx
  • models/integrations/stable-baselines-3.mdx
  • models/integrations/tensorboard.mdx
  • models/integrations/tensorflow.mdx
  • models/integrations/torchtune.mdx
  • models/integrations/ultralytics.mdx
  • models/integrations/w-and-b-for-julia.mdx
  • models/integrations/xgboost.mdx
  • models/integrations/yolov5.mdx
  • models/integrations/yolox.mdx

Recommendations for technical review

Prerequisites

  • Most pages lack a dedicated Prerequisites section. Consider adding one across the integration set covering required Python version, W&B account / wandb login, and minimum versions of wandb and the integration package. Affected pages include accelerate.mdx, add-wandb-to-any-library.mdx, autotrain.mdx, azure-openai-fine-tuning.mdx, catalyst.mdx, cohere-fine-tuning.mdx, composer.mdx, dagster.mdx, databricks.mdx, deepchecks.mdx, deepchem.mdx, diffusers.mdx, docker.mdx, dspy.mdx, farama-gymnasium.mdx, fastai.mdx, fastai/v1.mdx, huggingface.mdx, huggingface_transformers.mdx, hydra.mdx, ignite.mdx, keras.mdx, lightgbm.mdx, lightning.mdx, metaflow.mdx, mmf.mdx, nim.mdx, openai-api.mdx, openai-fine-tuning.mdx, openai-gym.mdx, paddledetection.mdx, paddleocr.mdx, prodigy.mdx, pytorch-geometric.mdx, pytorch.mdx, ray-tune.mdx, sagemaker.mdx, scikit.mdx, simpletransformers.mdx, skorch.mdx, spacy.mdx, stable-baselines-3.mdx, tensorflow.mdx, torchtune.mdx, ultralytics.mdx, w-and-b-for-julia.mdx, xgboost.mdx, yolov5.mdx, and yolox.mdx.
  • Several pages reference variables ($ENTITY, $PROJECT, $QUEUE, $CONFIG_JSON_FNAME in nim.mdx; FINETUNE_JOB_ID in openai-fine-tuning.mdx) or placeholder ellipses without defining them. Consider replacing with concrete examples or bracketed placeholders such as [ENTITY-NAME].
  • cohere-fine-tuning.mdx and deepchem.mdx use ellipsis placeholders (..., …) in code where readers need real argument shapes.
  • sagemaker.mdx should clarify IAM permissions and how secrets.env connects to wandb.init().
  • nim.mdx references an external personal git branch (andrew/nim-updates) and a sandbox container image (gcr.io/playground-111/...) — confirm whether these should point to stable, public references.

Verification steps

  • Most pages do not describe what the reader should see in W&B after completing each major step (run URL printed to stdout, location of logged metrics/artifacts/media in the UI, confirmation that a checkpoint or table uploaded). Consider adding short "what you'll see" descriptions across the integration set, particularly after install/login steps and after the first logging call.
  • accelerate.mdx, composer.mdx, dagster.mdx, databricks.mdx, deepchecks.mdx, deepchem.mdx, diffusers.mdx, dspy.mdx, huggingface.mdx, huggingface_transformers.mdx, hydra.mdx, ignite.mdx, lightning.mdx, metaflow.mdx, nim.mdx, openai-fine-tuning.mdx, paddleocr.mdx, prodigy.mdx, pytorch.mdx, sagemaker.mdx, scikit.mdx, stable-baselines-3.mdx, tensorflow.mdx, torchtune.mdx, ultralytics.mdx, w-and-b-for-julia.mdx, yolov5.mdx, and yolox.mdx are notable instances.

Technical accuracy

  • Code sample syntax errors and likely bugs:
    • accelerate.mdx (lines 22-25): missing commas in the init_trackers call cause a SyntaxError.
    • cohere-fine-tuning.mdx: undefined Settings and co symbols; code comment typo enitity → entity.
    • composer.mdx: confirm wandb.init() inside eval_end doesn't create duplicate runs with WandBLogger; line 35 uses project="gpt-5".
    • dagster.mdx (line 130): base_dir documented as (int, optional) but should be str.
    • deepchecks.mdx: code comment typo thes → these.
    • huggingface_transformers.mdx: run.use_artifact(my_model_name) references undefined my_model_name instead of the preceding my_checkpoint_name.
    • hydra.mdx: wandb.init is called twice (via with and then again as run = wandb.init(...)).
    • ignite.mdx: import uses deprecated ignite.contrib.handlers.wandb_logger; "mninst" is a typo for "mnist"; prose EVENTS vs. code Events casing mismatch.
    • keras.mdx: line 142 unterminated string filepath="models/,; malformed inline code `{`auto`, `min`, `max`}`; stray trailing pipe and inconsistent type labels in the WandbCallback reference table.
    • lightning.mdx: wandblogger.watch() missing underscore; metric_vale typo; legacy gpus=2 argument; malformed list comprehension in Option 2 callback example.
    • pytorch.mdx: indentation bug in opening snippet (loop body not indented); nested wandb.init() calls in model_pipeline/train/test; hardcoded nn.Conv2d(16, kernels[1], ...); non-deterministic seeds using hash(...) % 2**32 - 1; unused total_batches; off-by-one in batch reporting.
    • scikit.mdx (line 69): missing with keyword; lines 273-274 appear to swap classification vs. regression metrics; line 229 has a missing closing quote in ['width', 'height, 'length'].
    • tensorboard.mdx (line 27): missing with keyword; line 60 placeholder uses angle brackets; line 67 tensorboard_x parameter name needs verification; line 101 has vestigial f string prefixes and uses glob.glob without import glob.
    • tensorflow.mdx: tf.FLAGS vs. tf.flags.FLAGS inconsistency; line 73 run.log("loss": loss.numpy()) is invalid Python.
    • xgboost.mdx (line 23): import xgboost as XGBClassifier aliases the wrong thing; line 25 references undefined X_train, y_train, wandb.
    • openai-gym.mdx (line 18): truncated sentence and malformed link by[ CleanRL].
    • yolox.mdx: num_eval_imges typo (or upstream-mirrored?); training command missing trailing backslash for shell continuation.
    • ultralytics.mdx: inference example uses image filenames (img1.jpeg, img3.png) that don't match the files downloaded by the preceding wget block.
  • API and version currency to confirm:
    • accelerate.mdx: prose references wandb.Run.log() while the example uses accelerator.log().
    • add-wandb-to-any-library.mdx: wandb==0.13.* pin; semantic equivalence of wandb.init(mode="disabled") / WANDB_MODE=disabled / wandb disabled; wandb.Run.config.update vs. run.config.update; artifact reference syntax.
    • autotrain.mdx: autotrain-advanced CLI phrasing; --lr str(learning_rate) syntax in notebook block.
    • azure-openai-fine-tuning.mdx: confirm zero-code claim, supported model list (GPT-4o, GPT-4.1), and that the Azure docs link target is correct (currently a wandb.me redirect).
    • composer.mdx: defaults for rank_zero_only and log_artifacts; current Composer State API (state.timer vs. state.timestamp, state.batch_pair, state.outputs).
    • dagster.mdx: aliases vs. tags semantics; current Launch beta status; "Dagit" naming (now "Dagster UI").
    • databricks.mdx: databricks-cli legacy CLI flags vs. the newer databricks CLI; whether the Sweeps env-var workaround is still required.
    • farama-gymnasium.mdx: confirm gymnasium.wrappers.Monitor wrapper name (Gymnasium has renamed/removed it in favor of RecordVideo); line-anchored GitHub link is rot-prone.
    • huggingface_transformers.mdx: TFTrainer is deprecated in recent versions.
    • keras.mdx: minimum SDK requirement 0.13.4 should be elevated; verify WandbCallback argument defaults.
    • lightning.mdx: wandb.require(experiment="service") currency; multi-GPU WANDB_DIR snippet completeness.
    • metaflow.mdx: conditional install for wandb ≤ 0.19.8 (fastcore<1.8.0 vs. plum-dispatch<3.0.0).
    • openai-api.mdx: confirm autolog is limited to OpenAI SDK ≤ 0.28.1, and that autolog.disable() is the correct call.
    • openai-fine-tuning.mdx: 60-second poll interval for wait_for_job_success; key name fine_tuned_model vs. fine_tuned_model_id in model_metadata.json.
    • paddleocr.mdx: YAML Global: / True capitalization, and currency of release/2.5/tools/train.py.
    • pytorch.mdx: torch.onnx.export pattern currency; wandb.sweep without project argument; offline-mode terminology (dryrun vs. WANDB_MODE=offline).
    • ray-tune.mdx: tune.report vs. train.report — confirm which is current.
    • sagemaker.mdx: Python 2 psutil wheel workaround likely stale; wandb.sagemaker_auth and wandb.Settings(sagemaker_disable=True) API currency.
    • stable-baselines-3.mdx: gym is deprecated in favor of gymnasium; the title "Stable Baselines 3 PyTorch" reads oddly.
    • tensorboard.mdx: TensorBoard 1.14+ constraint and wandb 0.20.0+ cloud-sync minimums.
    • tensorflow.mdx: page mixes TF1 (tf.Session(), estimators) and TF2 (tf.GradientTape) without versioning guidance; conflicting guidance on step arg with sync_tensorboard=True.
    • ultralytics.mdx: ultralytics==8.0.238 pin from late 2023 needs a freshness check.
    • w-and-b-for-julia.mdx: package casing (Wandb.jl vs. wandb.jl); whether the integration is still "unofficial/community" and whether the linked repo is still maintained.
  • Link and asset hygiene:
    • azure-openai-fine-tuning.mdx, catalyst.mdx, cohere-fine-tuning.mdx (kkt_ft_cookbooks feature branch), diffusers.mdx (<ColabLink> to lcm-diffusers.ipynb doesn't match shown SD 2.1 / SDXL content), fastai/v1.mdx (Hugging Face report linked from a fastai example), fastai.mdx (legacy app.wandb.ai/borisd13/demo_config link), huggingface.mdx (/models/integrations/huggingface/ may self-link), keras.mdx (YouTube URL has parameter ordering issues and a backslash-escaped ampersand), nim.mdx (Llama2-7b benchmark currency), prodigy.mdx (trailing-slash internal link), tensorboard.mdx (TensorBoard embedded-cloud note linking), yolov5.mdx (broken ../ placeholder link; wandb.com vs. wandb.ai domain).

Missing content

  • Troubleshooting / failure-mode guidance is absent on most pages. Pages that would particularly benefit: add-wandb-to-any-library.mdx, dagster.mdx, databricks.mdx, deepchem.mdx, docker.mdx, huggingface_transformers.mdx, nim.mdx, pytorch.mdx, simpletransformers.mdx, w-and-b-for-julia.mdx, yolox.mdx.
  • Pages that reference features they don't demonstrate or define:
    • accelerate.mdx: <Warning> block describing default behavior may be more appropriate as <Note>.
    • catalyst.mdx: lists supported logging types only at a high level; consider a minimal WandbLogger(...) snippet to match skorch.mdx/ignite.mdx.
    • deepchem.mdx: intro promises "model checkpointing" but no section covers it.
    • dspy.mdx: dspy.Evaluate, MIPROv2, dspy.ChainOfThought, and "program signature evolution" used without definition or link.
    • farama-gymnasium.mdx: no end-to-end snippet showing wandb.init(..., monitor_gym=True) with a Gymnasium env.
    • keras.mdx: "It also logs:" on line 62 has no following list; FAQ section has only one entry; "Memory footprint details" section references an example that doesn't appear.
    • lightning.mdx: "Log gradients, parameter histogram and model topology" trails off without a target/link.
    • mmf.mdx: no end-to-end "enable and run" flow.
    • nim.mdx: confirm whether "NV-GPT" support shipped or was renamed; consider Llama 3+.
    • openai-fine-tuning.mdx: W&B Registry, Artifacts, Tables references lack inline definitions/links.
    • pytorch.mdx: no DDP/distributed-training section; "Define testing logic" jumps straight to a run.save() subsection.
    • pytorch-geometric.mdx: snippets reference tqdm, nx, go, graph without imports or context for obtaining a PyG graph object.
    • tensorboard.mdx: undefined terms (TensorBoard tab, tfevents, .pbtxt, SummaryWriter).
    • yolov5.mdx: no caveats on --upload_dataset (size, format, rate limits).
  • Code-comment / non-code typos to consider during a technical-edit pass: composer.mdx (# stores / stray "logs it" literal), dagster.mdx (# this will be stored in an Artifact future tense), databricks.mdx (Sweeps section context), pytorch-geometric.mdx ("visualisation" in PyVis comment), cohere-fine-tuning.mdx (enitity), deepchecks.mdx (thes), keras.mdx (table type labels), dagster.mdx (mixed YAML/Python in a single python fence).
  • Audit consistency:
    • accelerate.mdx, databricks.mdx, nim.mdx: pages use phrasing tightened from older "this will be necessary in the future" hedges — confirm whether each workaround is still required.
    • cohere-fine-tuning.mdx: SoTA claim was downgraded to "evaluates pass@1" — confirm whether the page is meant to reproduce a specific benchmark.
    • prodigy.mdx: "tries to convert" → "automatically converts" may now over-promise.

How to review

  • Each file's changes are style edits only. Compare side-by-side and flag any that change technical meaning.
  • Approve and merge to accept the edits, or close to reject them.

@johndmulhausen johndmulhausen requested a review from a team as a code owner May 27, 2026 05:56
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 27, 2026 •
edited
Loading

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

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview May 27, 2026, 6:01 AM

@johndmulhausen johndmulhausen enabled auto-merge (squash) May 27, 2026 05:58
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026 •
edited
Loading

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (52 total)

📄 Pages (52)

File Preview
models/integrations/accelerate.mdx Accelerate
models/integrations/add-wandb-to-any-library.mdx Add Wandb To Any Library
models/integrations/autotrain.mdx Autotrain
models/integrations/azure-openai-fine-tuning.mdx Azure Openai Fine Tuning
models/integrations/catalyst.mdx Catalyst
models/integrations/cohere-fine-tuning.mdx Cohere Fine Tuning
models/integrations/composer.mdx Composer
models/integrations/dagster.mdx Dagster
models/integrations/databricks.mdx Databricks
models/integrations/deepchecks.mdx Deepchecks
... and 42 more files

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: f5cade1 at 2026-05-27 17:12:04 UTC

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026 •
edited
Loading

🔗 Link Checker Results

✅ All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-style-guide-models-integrations-20260527-015516.mintlify.app

@johndmulhausen
style: add search keywords to models/integrations pages
9fe77da 
Add frontmatter keywords per updated style-guide guidance for Mintlify search relevance.
@johndmulhausen
style: update frontmatter keywords on models/integrations pages
f5cade1 
Revises the keywords added in the previous commit to align with the
updated guidance in docs-skills structure-pass.md: prefer specific API
names, acronyms, and phrases over terms that overlap with the page
title or description. Drops redundant name repetitions and adds more
targeted terms (for example BootstrapFewShot, LGBMClassifier, pp-OCR,
YOLOv8/YOLOv11).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@johndmulhausen