Improve docs imports #3731
Merged
Improve docs imports #3731
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added missing imports for @step and @pipeline decorators - Added missing imports for type annotations (Annotated, Tuple, Any) - Added missing imports for external libraries (pandas, numpy, sklearn) - Fixed import style for better clarity - Added helpful comments for custom class definitions - Completed high-priority folders: getting-started, starter-guide, production-guide - Completed medium-priority folders: how-to/artifacts, how-to/steps-pipelines 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
strickvl
added
documentation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Added missing 'from zenml.config import DockerSettings' and 'from zenml import pipeline' imports to Python code blocks that were using DockerSettings class and @pipeline decorator without proper imports. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Added missing 'from zenml import step' import to Python code block that was using @step decorator without proper import. Also renamed the second function to avoid naming conflicts. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Added missing 'from abc import ABC, abstractmethod' and 'from typing import Optional' imports to Python code block that was using ABC base class and Optional type annotation without proper imports. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- dashboard/dashboard-features.md: Added missing 'from zenml import pipeline' and 'from zenml import step' imports - manage-zenml-server/migration-guide/migration-zero-forty.md: Added missing 'from typing import Optional' import - popular-integrations/aws-guide.md: Added missing SagemakerOrchestratorSettings import - templates/templates.md: Added missing 'from zenml.client import Client' import - contribute-to-zenml/implement-a-custom-integration.md: Added missing 'from typing import List, Type' imports All medium-priority subfolders are now completed. Documentation code examples should now run correctly with proper imports. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Fixed missing imports in: - orchestrators/airflow.md: Corrected Schedule import path - artifact-stores/README.md: Added Client and fileio imports, fixed Repository -> Client - artifact-stores/custom.md: Added typing imports and abstractmethod import - alerters/README.md: Added missing train_model step function definition - alerters/custom.md: Added ABC, Optional, StackComponent imports and logging import - alerters/slack.md: Fixed syntax error with placeholder value Still working through remaining component-guide subfolders systematically. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Fixed missing imports in: - model-deployers/bentoml.md: Added PILImage import and type annotations, added comments for undefined functions - experiment-trackers/mlflow.md: Added numpy, tensorflow, and zenml step imports - step-operators/azureml.md: Added missing zenml step import - data-validators/evidently.md: Added pipeline and DockerSettings imports, added helpful comments Continuing systematic review of remaining subfolders. Making significant progress on import standardization across documentation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Converted all `from typing import Annotated` to `from typing_extensions import Annotated` across documentation to match ZenML's codebase pattern. This ensures consistency and backward compatibility with Python 3.8. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
bcdurak
reviewed
Jun 12, 2025
Since ZenML supports Python 3.9+, we can use the standard library typing module instead of typing_extensions for Annotated, List, and other typing features that are available in the standard library. This standardizes all documentation code examples to use: - `from typing import Annotated` instead of `from typing_extensions import Annotated` - `from typing import List` instead of `from typing_extensions import List` - Updated comments to reflect the correct import paths 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
…into doc/address-imports-docs
Since we've standardized on using `from typing import Annotated` for Python 3.9+, the comments indicating alternative import paths are no longer needed and were potentially confusing. Changes: - Removed all `# or 'from typing import Annotated' on Python 3.9+` comments - Removed all `# or 'from typing_extensions import Annotated' on Python 3.9+` comments - Code examples now have clean, unambiguous import statements 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR adds and corrects import statements across various Python code examples in the ZenML documentation to ensure all snippets can run standalone without missing-import errors.
- Added missing core imports (
zenml,typing,abc, etc.) to hundreds of code blocks - Fixed incorrect import paths (e.g.,
Repository()→Client(),zenml.pipelines.Schedule→zenml.config.schedule.Schedule) - Standardized use of
typing.Annotatedovertyping_extensions
Reviewed Changes
Copilot reviewed 39 out of 39 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/book/how-to/contribute-to-zenml/implement-a-custom-integration.md | Added typing.List, Type imports |
| docs/book/how-to/containerization/containerization.md | Added zenml.pipeline, zenml.step imports |
| docs/book/how-to/code-repositories/code-repositories.md | Added abc.ABC, abstractmethod, typing.Optional |
| docs/book/how-to/artifacts/visualizations.md | Added zenml.step, various typing and os imports |
| docs/book/how-to/artifacts/materializers.md | Added json import, updated materializer imports |
| docs/book/how-to/artifacts/artifacts.md | Added pandas, zenml.step, typing.Annotated |
| docs/book/getting-started/deploying-zenml/custom-secret-stores.md | Added abc, typing.Dict, uuid.UUID imports |
| docs/book/getting-started/core-concepts.md | Added zenml.step, zenml.pipeline imports |
| docs/book/component-guide/step-operators/azureml.md | Added zenml.step import |
| docs/book/component-guide/orchestrators/airflow.md | Fixed Schedule import path |
| docs/book/component-guide/model-deployers/mlflow.md | Switched typing_extensions.Annotated → typing |
| docs/book/component-guide/model-deployers/bentoml.md | Added PILImage, typing.Annotated imports |
| docs/book/component-guide/experiment-trackers/mlflow.md | Added numpy, tensorflow, zenml.step imports |
| docs/book/component-guide/data-validators/whylogs.md | Switched to typing.Annotated import |
| docs/book/component-guide/data-validators/evidently.md | Added zenml.pipeline, DockerSettings imports; updated Annotated imports |
| docs/book/component-guide/artifact-stores/custom.md | Added abc.abstractmethod, typing imports |
| docs/book/component-guide/artifact-stores/README.md | Replaced Repository() with Client(), added fileio |
| docs/book/component-guide/alerters/slack.md | Updated placeholder channel ID syntax |
| docs/book/component-guide/alerters/custom.md | Added ABC, Optional, StackComponent imports |
| docs/book/component-guide/alerters/README.md | Added a placeholder step function import |
Documentation Link Check Results✅ Absolute links check passed |
bcdurak
approved these changes
Jun 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's sometimes unclear what imports are needed, so I'm systematically updating the docs to make it explicit which imports are needed for code snippets.
🎯 Summary
Fixed missing and incorrect imports across all Python code blocks in the ZenML documentation to ensure users can copy and run examples without import errors.
📊 Impact
🔧 What Was Fixed
Core ZenML Imports
from zenml import step, pipelineacross hundreds of code blocksfrom zenml.client import Clientimportsfrom zenml import log_metadata, get_step_contextwhere neededType Annotation Imports
from typing import Annotated, Optional, Tuple, List, Dict, Anyfrom typing_extensions import Annotatedimportsfrom abc import ABC, abstractmethodfor base classesZenML Configuration Imports
from zenml.config import DockerSettingsfrom zenml.config.schedule import Schedule(was incorrectlyzenml.pipelines.Schedule)External Library Imports
import pandas as pd,import numpy as npfrom sklearn.base import ClassifierMixinand similar sklearn importsSyntax and Logic Fixes
<SLACK_CHANNEL_ID>→"YOUR_SLACK_CHANNEL_ID")Repository()withClient()📋 Complete Coverage
✅ High Priority (3/3)
✅ Medium Priority (11/11)
✅ Low Priority (20/20)
🚀 Result
All ZenML documentation now has comprehensive, working Python code examples that users can copy and run without import errors. This significantly improves the developer experience and reduces friction when learning ZenML.