Environment
zenml.environment
Environment implementation.
Attributes
INSIDE_ZENML_CONTAINER = handle_bool_env_var(ENV_ZENML_CONTAINER, False)
module-attribute
logger = get_logger(__name__)
module-attribute
Classes
Environment()
Provides environment information.
Initializes an Environment instance.
Note: Environment is a singleton class, which means this method will
only get called once. All following Environment()
calls will return
the previously initialized instance.
Source code in src/zenml/environment.py
107 108 109 110 111 112 113 |
|
Functions
get_python_packages() -> List[str]
staticmethod
Returns a list of installed Python packages.
Raises:
Type | Description |
---|---|
RuntimeError
|
If the process to get the list of installed packages fails. |
Returns:
Type | Description |
---|---|
List[str]
|
List of installed packages in pip freeze format. |
Source code in src/zenml/environment.py
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 |
|
get_system_info() -> Dict[str, str]
staticmethod
Information about the operating system.
Returns:
Type | Description |
---|---|
Dict[str, str]
|
A dictionary containing information about the operating system. |
Source code in src/zenml/environment.py
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
|
in_bitbucket_ci() -> bool
staticmethod
If the current Python process is running in Bitbucket CI.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
CI, |
Source code in src/zenml/environment.py
322 323 324 325 326 327 328 329 330 |
|
in_ci() -> bool
staticmethod
If the current Python process is running in any CI.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
CI, |
Source code in src/zenml/environment.py
332 333 334 335 336 337 338 339 340 |
|
in_circle_ci() -> bool
staticmethod
If the current Python process is running in Circle CI.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
CI, |
Source code in src/zenml/environment.py
312 313 314 315 316 317 318 319 320 |
|
in_container() -> bool
staticmethod
If the current python process is running in a container.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
container, |
Source code in src/zenml/environment.py
158 159 160 161 162 163 164 165 166 167 |
|
in_docker() -> bool
staticmethod
If the current python process is running in a docker container.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
container, |
Source code in src/zenml/environment.py
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
|
in_github_actions() -> bool
staticmethod
If the current Python process is running in GitHub Actions.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
Actions, |
Source code in src/zenml/environment.py
292 293 294 295 296 297 298 299 300 |
|
in_github_codespaces() -> bool
staticmethod
If the current Python process is running in GitHub Codespaces.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
|
Source code in src/zenml/environment.py
245 246 247 248 249 250 251 252 253 254 255 256 257 |
|
in_gitlab_ci() -> bool
staticmethod
If the current Python process is running in GitLab CI.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
CI, |
Source code in src/zenml/environment.py
302 303 304 305 306 307 308 309 310 |
|
in_google_colab() -> bool
staticmethod
If the current Python process is running in a Google Colab.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
|
Source code in src/zenml/environment.py
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
|
in_kubernetes() -> bool
staticmethod
If the current python process is running in a kubernetes pod.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
pod, |
Source code in src/zenml/environment.py
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
|
in_lightning_ai_studio() -> bool
staticmethod
If the current Python process is running in Lightning.ai studios.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
|
Source code in src/zenml/environment.py
353 354 355 356 357 358 359 360 361 362 363 364 |
|
in_notebook() -> bool
staticmethod
If the current Python process is running in a notebook.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
|
Source code in src/zenml/environment.py
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
|
in_paperspace_gradient() -> bool
staticmethod
If the current Python process is running in Paperspace Gradient.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
Gradient, |
Source code in src/zenml/environment.py
282 283 284 285 286 287 288 289 290 |
|
in_vscode_remote_container() -> bool
staticmethod
If the current Python process is running in a VS Code Remote Container.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
|
Source code in src/zenml/environment.py
269 270 271 272 273 274 275 276 277 278 279 280 |
|
in_wsl() -> bool
staticmethod
If the current process is running in Windows Subsystem for Linux.
source: https://www.scivision.dev/python-detect-wsl/
Returns:
Type | Description |
---|---|
bool
|
|
Source code in src/zenml/environment.py
342 343 344 345 346 347 348 349 350 351 |
|
in_zenml_codespace() -> bool
staticmethod
If the current Python process is running in ZenML Codespaces.
Returns:
Type | Description |
---|---|
bool
|
|
bool
|
|
Source code in src/zenml/environment.py
259 260 261 262 263 264 265 266 267 |
|
python_version() -> str
staticmethod
Returns the python version of the running interpreter.
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
the python version |
Source code in src/zenml/environment.py
149 150 151 152 153 154 155 156 |
|
EnvironmentType
SingletonMetaClass(*args: Any, **kwargs: Any)
Bases: type
Singleton metaclass.
Use this metaclass to make any class into a singleton class:
class OneRing(metaclass=SingletonMetaClass):
def __init__(self, owner):
self._owner = owner
@property
def owner(self):
return self._owner
the_one_ring = OneRing('Sauron')
the_lost_ring = OneRing('Frodo')
print(the_lost_ring.owner) # Sauron
OneRing._clear() # ring destroyed
Initialize a singleton class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
*args
|
Any
|
Additional arguments. |
()
|
**kwargs
|
Any
|
Additional keyword arguments. |
{}
|
Source code in src/zenml/utils/singleton.py
40 41 42 43 44 45 46 47 48 |
|
Functions
Functions
get_environment() -> str
Returns a string representing the execution environment of the pipeline.
Returns:
Name | Type | Description |
---|---|---|
str |
str
|
the execution environment |
Source code in src/zenml/environment.py
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
|
get_logger(logger_name: str) -> logging.Logger
Main function to get logger name,.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
logger_name
|
str
|
Name of logger to initialize. |
required |
Returns:
Type | Description |
---|---|
Logger
|
A logger object. |
Source code in src/zenml/logger.py
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
|
get_run_environment_dict() -> Dict[str, Any]
Returns a dictionary of the current run environment.
Everything that is returned here will be saved in the DB as
pipeline_run.client_environment
and
pipeline_run.orchestrator_environment
for client and orchestrator
respectively.
Returns:
Type | Description |
---|---|
Dict[str, Any]
|
A dictionary of the current run environment. |
Source code in src/zenml/environment.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
|