Session
kedro.framework.session ¶
kedro.framework.session provides access to KedroSession responsible for
project lifecycle.
| Module | Description |
|---|---|
kedro.framework.session.session |
Implements Kedro session responsible for project lifecycle. |
kedro.framework.session.store |
Implements a dict-like store object used to persist Kedro sessions. |
kedro.framework.session.session ¶
This module implements Kedro session responsible for project lifecycle.
AbstractConfigLoader ¶
AbstractConfigLoader(conf_source, env=None, runtime_params=None, **kwargs)
Bases: UserDict
AbstractConfigLoader is the abstract base class
for all ConfigLoader implementations.
All user-defined ConfigLoader implementations should inherit
from AbstractConfigLoader and implement all relevant abstract methods.
Source code in kedro/config/abstract_config.py
19 20 21 22 23 24 25 26 27 28 29 | |
get ¶
get(key, default=None)
D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.
Source code in kedro/config/abstract_config.py
35 36 37 38 39 40 | |
AbstractRunner ¶
AbstractRunner(is_async=False)
Bases: ABC
AbstractRunner is the base class for all Pipeline runner
implementations.
Parameters:
-
is_async(bool, default:False) –If True, the node inputs and outputs are loaded and saved asynchronously with threads. Defaults to False.
Source code in kedro/runner/runner.py
44 45 46 47 48 49 50 51 52 53 54 | |
run ¶
run(pipeline, catalog, hook_manager=None, run_id=None, only_missing_outputs=False)
Run the Pipeline using the datasets provided by catalog
and save results back to the same objects.
Parameters:
-
pipeline(Pipeline) –The
Pipelineto run. -
catalog(CatalogProtocol | SharedMemoryCatalogProtocol) –An implemented instance of
CatalogProtocolorSharedMemoryCatalogProtocolfrom which to fetch data. -
hook_manager(PluginManager | None, default:None) –The
PluginManagerto activate hooks. -
run_id(str | None, default:None) –The id of the run.
-
only_missing_outputs(bool, default:False) –Run only nodes with missing outputs.
Raises:
-
ValueError–Raised when
Pipelineinputs cannot be satisfied.
Returns:
-
dict[str, Any]–Dictionary with pipeline outputs, where keys are dataset names
-
dict[str, Any]–and values are dataset objects.
Source code in kedro/runner/runner.py
60 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 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 | |
AbstractSession ¶
Bases: ABC
AbstractSession is the base class for all Kedro session implementations.
Subclasses must implement the create, close, and run methods.
close
abstractmethod
¶
close()
Close the current session.
Source code in kedro/framework/session/abstract_session.py
23 24 25 26 | |
create
abstractmethod
classmethod
¶
create()
Create a new instance of the session.
Source code in kedro/framework/session/abstract_session.py
15 16 17 18 19 20 21 | |
run
abstractmethod
¶
run()
Run the pipeline.
Source code in kedro/framework/session/abstract_session.py
28 29 30 31 | |
BaseSessionStore ¶
BaseSessionStore(path, session_id)
Bases: UserDict
BaseSessionStore is the base class for all session stores.
BaseSessionStore is an ephemeral store implementation that doesn't
persist the session data.
Source code in kedro/framework/session/store.py
16 17 18 19 | |
read ¶
read()
Read the data from the session store.
Returns:
-
dict[str, Any]–A mapping containing the session store data.
Source code in kedro/framework/session/store.py
25 26 27 28 29 30 31 32 33 34 35 | |
save ¶
save()
Persist the session store
Source code in kedro/framework/session/store.py
37 38 39 40 41 42 | |
KedroContext ¶
KedroContext is the base class which holds the configuration and
Kedro's main functionality.
Create a context object by providing the root of a Kedro project and
the environment configuration subfolders (see kedro.config.OmegaConfigLoader)
Raises:
KedroContextError: If there is a mismatch
between Kedro project version and package version.
Args:
project_path: Project path to define the context for.
config_loader: Kedro's OmegaConfigLoader for loading the configuration files.
env: Optional argument for configuration default environment to be used
for running the pipeline. If not specified, it defaults to "local".
package_name: Package name for the Kedro project the context is
created for.
hook_manager: The PluginManager to activate hooks, supplied by the session.
runtime_params: Optional dictionary containing runtime project parameters.
If specified, will update (and therefore take precedence over)
the parameters retrieved from the project configuration.
catalog
property
¶
catalog
Read-only property referring to Kedro's catalog` for this context.
Returns:
-
CatalogProtocol–catalog defined in
catalog.yml.
Raises: KedroContextError: Incorrect catalog registered for the project.
params
property
¶
params
Read-only property referring to Kedro's parameters for this context.
Returns:
-
dict[str, Any]–Parameters defined in
parameters.ymlwith the addition of any extra parameters passed at initialization. Parameters are validated and transformed according to pipeline node type hints.
KedroSession ¶
KedroSession(session_id, package_name=None, project_path=None, save_on_close=False, conf_source=None)
Bases: AbstractSession
KedroSession is the object that is responsible for managing the lifecycle
of a Kedro run. Use KedroSession.create() as
a context manager to construct a new KedroSession with session data
provided (see the example below).
Example:
from kedro.framework.session import KedroSession
from kedro.framework.startup import bootstrap_project
from pathlib import Path
# If you are creating a session outside of a Kedro project (i.e. not using
# `kedro run` or `kedro jupyter`), you need to run `bootstrap_project` to
# let Kedro find your configuration.
bootstrap_project(Path("<project_root>"))
with KedroSession.create() as session:
session.run()
Source code in kedro/framework/session/session.py
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | |
close ¶
close()
Close the current session and save its store to disk
if save_on_close attribute is True.
Source code in kedro/framework/session/session.py
269 270 271 272 273 274 | |
create
classmethod
¶
create(project_path=None, save_on_close=True, env=None, runtime_params=None, conf_source=None)
Create a new instance of KedroSession with the session data.
Parameters:
-
project_path(Path | str | None, default:None) –Path to the project root directory. Default is current working directory Path.cwd().
-
save_on_close(bool, default:True) –Whether or not to save the session when it's closed.
-
conf_source(str | None, default:None) –Path to a directory containing configuration
-
env(str | None, default:None) –Environment for the KedroContext.
-
runtime_params(dict[str, Any] | None, default:None) –Optional dictionary containing extra project parameters for underlying KedroContext. If specified, will update (and therefore take precedence over) the parameters retrieved from the project configuration.
Returns:
-
KedroSession–A new
KedroSessioninstance.
Source code in kedro/framework/session/session.py
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | |
load_context ¶
load_context()
An instance of the project context.
Source code in kedro/framework/session/session.py
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 | |
run ¶
run(pipeline_name=None, pipeline_names=None, tags=None, runner=None, node_names=None, from_nodes=None, to_nodes=None, from_inputs=None, to_outputs=None, load_versions=None, namespaces=None, only_missing_outputs=False)
Runs the pipeline with a specified runner.
Parameters:
-
pipeline_name(str | None, default:None) –Name of the pipeline that is being run.
-
pipeline_names(list[str] | None, default:None) –Name of the pipelines that is being run.
-
tags(Iterable[str] | None, default:None) –An optional list of node tags which should be used to filter the nodes of the
Pipeline. If specified, only the nodes containing any of these tags will be run. -
runner(AbstractRunner | None, default:None) –An optional parameter specifying the runner that you want to run the pipeline with.
-
node_names(Iterable[str] | None, default:None) –An optional list of node names which should be used to filter the nodes of the
Pipeline. If specified, only the nodes with these names will be run. -
from_nodes(Iterable[str] | None, default:None) –An optional list of node names which should be used as a starting point of the new
Pipeline. -
to_nodes(Iterable[str] | None, default:None) –An optional list of node names which should be used as an end point of the new
Pipeline. -
from_inputs(Iterable[str] | None, default:None) –An optional list of input datasets which should be used as a starting point of the new
Pipeline. -
to_outputs(Iterable[str] | None, default:None) –An optional list of output datasets which should be used as an end point of the new
Pipeline. -
load_versions(dict[str, str] | None, default:None) –An optional flag to specify a particular dataset version timestamp to load.
-
namespaces(Iterable[str] | None, default:None) –The namespaces of the nodes that are being run.
-
only_missing_outputs(bool, default:False) –Run only nodes with missing outputs.
Raises:
ValueError: If the named or __default__ pipeline is not
defined by register_pipelines.
Exception: Any uncaught exception during the run will be re-raised
after being passed to on_pipeline_error hook.
KedroSessionError: If more than one run is attempted to be executed during
a single session.
Returns:
Dictionary with pipeline outputs, where keys are dataset names
and values are dataset objects.
Source code in kedro/framework/session/session.py
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 | |
KedroSessionError ¶
Bases: Exception
KedroSessionError raised by KedroSession
in the case that multiple runs are attempted in one session.
ParallelRunner ¶
ParallelRunner(max_workers=None, is_async=False)
Bases: AbstractRunner
ParallelRunner is an AbstractRunner implementation. It can
be used to run the Pipeline in parallel groups formed by toposort.
Please note that this runner implementation validates dataset using the
_validate_catalog method, which checks if any of the datasets are
single process only using the _SINGLE_PROCESS dataset attribute.
Parameters:
-
max_workers(int | None, default:None) –Number of worker processes to spawn. If not set, calculated automatically based on the pipeline configuration and CPU core count. On windows machines, the max_workers value cannot be larger than 61 and will be set to min(61, max_workers).
-
is_async(bool, default:False) –If True, the node inputs and outputs are loaded and saved asynchronously with threads. Defaults to False.
Raises: ValueError: bad parameters passed
Source code in kedro/runner/parallel_runner.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 | |
Pipeline ¶
Pipeline(nodes, *, inputs=None, outputs=None, parameters=None, tags=None, namespace=None, prefix_datasets_with_namespace=True)
A Pipeline defined as a collection of Node objects. This class
treats nodes as part of a graph representation and provides inputs,
outputs and execution order.
Parameters:
-
nodes(Iterable[Node | Pipeline] | Pipeline) –The iterable of nodes the
Pipelinewill be made of. If you provide pipelines among the list of nodes, those pipelines will be expanded and all their nodes will become part of this new pipeline. -
inputs(str | set[str] | dict[str, str] | None, default:None) –A name or collection of input names to be exposed as connection points to other pipelines upstream. This is optional; if not provided, the pipeline inputs are automatically inferred from the pipeline structure. When str or set[str] is provided, the listed input names will stay the same as they are named in the provided pipeline. When dict[str, str] is provided, current input names will be mapped to new names. Must only refer to the pipeline's free inputs.
-
outputs(str | set[str] | dict[str, str] | None, default:None) –A name or collection of names to be exposed as connection points to other pipelines downstream. This is optional; if not provided, the pipeline outputs are automatically inferred from the pipeline structure. When str or set[str] is provided, the listed output names will stay the same as they are named in the provided pipeline. When dict[str, str] is provided, current output names will be mapped to new names. Can refer to both the pipeline's free outputs, as well as intermediate results that need to be exposed.
-
parameters(str | set[str] | dict[str, str] | None, default:None) –A name or collection of parameters to namespace. When str or set[str] are provided, the listed parameter names will stay the same as they are named in the provided pipeline. When dict[str, str] is provided, current parameter names will be mapped to new names. The parameters can be specified without the
params:prefix. -
tags(str | Iterable[str] | None, default:None) –Optional set of tags to be applied to all the pipeline nodes.
-
namespace(str | None, default:None) –A prefix to give to all dataset names, except those explicitly named with the
inputs/outputsarguments, and parameter references (params:andparameters). -
prefix_datasets_with_namespace(bool, default:True) –A flag to specify if the inputs, outputs, and parameters of the nodes should be prefixed with the namespace. It is set to True by default. It is useful to turn off when namespacing is used for grouping nodes for deployment purposes.
Raises:
-
ValueError–When an empty list of nodes is provided, or when not all nodes have unique names.
-
CircularDependencyError–When visiting all the nodes is not possible due to the existence of a circular dependency.
-
OutputNotUniqueError–When multiple
Nodeinstances produce the same output. -
ConfirmNotUniqueError–When multiple
Nodeinstances attempt to confirm the same dataset. -
PipelineError–When inputs, outputs or parameters are incorrectly specified, or they do not exist on the original pipeline.
Example:
from kedro.pipeline import Pipeline
from kedro.pipeline import node
# In the following scenario first_ds and second_ds
# are datasets provided by io. Pipeline will pass these
# datasets to first_node function and provides the result
# to the second_node as input.
def first_node(first_ds, second_ds):
return dict(third_ds=first_ds + second_ds)
def second_node(third_ds):
return third_ds
pipeline = Pipeline(
[
node(first_node, ["first_ds", "second_ds"], ["third_ds"]),
node(second_node, dict(third_ds="third_ds"), "fourth_ds"),
]
)
pipeline.describe()
Source code in kedro/pipeline/pipeline.py
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | |
grouped_nodes
cached
property
¶
grouped_nodes
Return a list of the pipeline nodes in topologically ordered groups, i.e. if node A needs to be run before node B, it will appear in an earlier group.
Returns:
-
list[list[Node]]–The pipeline nodes in topologically ordered groups.
node_dependencies
cached
property
¶
node_dependencies
nodes
cached
property
¶
nodes
Return a list of the pipeline nodes in topological order, i.e. if node A needs to be run before node B, it will appear earlier in the list.
Returns:
-
list[Node]–The list of all pipeline nodes in topological order.
__repr__ ¶
__repr__()
Pipeline ([node1, ..., node10 ...], name='pipeline_name')
Source code in kedro/pipeline/pipeline.py
367 368 369 370 371 372 373 374 375 376 377 | |
all_inputs ¶
all_inputs()
All inputs for all nodes in the pipeline.
Returns:
-
set[str]–All node input names as a Set.
Source code in kedro/pipeline/pipeline.py
404 405 406 407 408 409 410 411 | |
all_outputs ¶
all_outputs()
All outputs of all nodes in the pipeline.
Returns:
-
set[str]–All node outputs.
Source code in kedro/pipeline/pipeline.py
413 414 415 416 417 418 419 420 | |
datasets ¶
datasets()
The names of all datasets used by the Pipeline,
including inputs and outputs.
Returns:
-
set[str]–The set of all pipeline datasets.
Source code in kedro/pipeline/pipeline.py
451 452 453 454 455 456 457 458 459 | |
describe ¶
describe(names_only=True)
Obtain the order of execution and expected free input variables in a loggable pre-formatted string. The order of nodes matches the order of execution given by the topological sort.
Parameters:
-
names_only(bool, default:True) –The flag to describe names_only pipeline with just node names.
Example:
pipeline = Pipeline([...])
logger = logging.getLogger(__name__)
logger.info(pipeline.describe())
After invocation the following will be printed as an info level log statement: ::
#### Pipeline execution order ####
Inputs: C, D
func1([C]) -> [A]
func2([D]) -> [B]
func3([A, D]) -> [E]
Outputs: B, E
##################################
Returns:
-
str–The pipeline description as a formatted string.
Source code in kedro/pipeline/pipeline.py
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 | |
filter ¶
filter(tags=None, from_nodes=None, to_nodes=None, node_names=None, from_inputs=None, to_outputs=None, node_namespaces=None)
Creates a new Pipeline object with the nodes that meet all of the
specified filtering conditions.
The new pipeline object is the intersection of pipelines that meet each filtering condition. This is distinct from chaining multiple filters together.
Parameters:
-
tags(Iterable[str] | None, default:None) –A list of node tags which should be used to lookup the nodes of the new
Pipeline. -
from_nodes(Iterable[str] | None, default:None) –A list of node names which should be used as a starting point of the new
Pipeline. -
to_nodes(Iterable[str] | None, default:None) –A list of node names which should be used as an end point of the new
Pipeline. -
node_names(Iterable[str] | None, default:None) –A list of node names which should be selected for the new
Pipeline. -
from_inputs(Iterable[str] | None, default:None) –A list of inputs which should be used as a starting point of the new
Pipeline -
to_outputs(Iterable[str] | None, default:None) –A list of outputs which should be the final outputs of the new
Pipeline. -
node_namespaces(Iterable[str] | None, default:None) –A list of node namespaces which should be used to select nodes in the new
Pipeline.
Returns:
-
Pipeline–A new
Pipelineobject with nodes that meet all of the specified filtering conditions.
Raises:
-
ValueError–The filtered
Pipelinehas no nodes.
Example:
pipeline = Pipeline(
[
node(func, "A", "B", name="node1"),
node(func, "B", "C", name="node2"),
node(func, "C", "D", name="node3"),
]
)
pipeline.filter(node_names=["node1", "node3"], from_inputs=["A"])
# Gives a new pipeline object containing node1 and node3.
Source code in kedro/pipeline/pipeline.py
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 | |
from_inputs ¶
from_inputs(*inputs)
Create a new Pipeline object with the nodes which depend
directly or transitively on the provided inputs.
If provided a name, but no format, for a transcoded input, it
includes all the nodes that use inputs with that name, otherwise it
matches to the fully-qualified name only (i.e. name@format).
Parameters:
-
*inputs(str, default:()) –A list of inputs which should be used as a starting point of the new
Pipeline
Raises:
-
ValueError–Raised when any of the given inputs do not exist in the
Pipelineobject.
Returns:
-
Pipeline–A new
Pipelineobject, containing a subset of the nodes of the current one such that only nodes depending directly or transitively on the provided inputs are being copied.
Source code in kedro/pipeline/pipeline.py
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 | |
from_nodes ¶
from_nodes(*node_names)
Create a new Pipeline object with the nodes which depend
directly or transitively on the provided nodes.
Parameters:
-
*node_names(str, default:()) –A list of node_names which should be used as a starting point of the new
Pipeline.
Raises:
ValueError: Raised when any of the given names do not exist in the
Pipeline object.
Returns:
A new Pipeline object, containing a subset of the nodes of
the current one such that only nodes depending directly or
transitively on the provided nodes are being copied.
Source code in kedro/pipeline/pipeline.py
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 | |
group_nodes_by ¶
group_nodes_by(group_by='namespace')
Return a list of grouped nodes based on the specified strategy.
Parameters:
-
group_by(str | None, default:'namespace') –Strategy for grouping. Supported values: - "namespace": Groups nodes by their top-level namespace. - None or "none": No grouping, each node is its own group.
Returns:
-
list[GroupedNodes]–A list of GroupedNodes instances.
Source code in kedro/pipeline/pipeline.py
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 | |
inputs ¶
inputs()
The names of free inputs that must be provided at runtime so that the pipeline is runnable. Does not include intermediate inputs which are produced and consumed by the inner pipeline nodes. Resolves transcoded names where necessary.
Returns:
-
set[str]–The set of free input names needed by the pipeline.
Source code in kedro/pipeline/pipeline.py
428 429 430 431 432 433 434 435 436 437 438 | |
only_nodes ¶
only_nodes(*node_names)
Create a new Pipeline which will contain only the specified
nodes by name.
Parameters:
-
*node_names(str, default:()) –One or more node names. The returned
Pipelinewill only contain these nodes.
Raises:
-
ValueError–When some invalid node name is given.
Returns:
-
Pipeline–A new
Pipeline, containing onlynodes.
Source code in kedro/pipeline/pipeline.py
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 | |
only_nodes_with_inputs ¶
only_nodes_with_inputs(*inputs)
Create a new Pipeline object with the nodes which depend
directly on the provided inputs.
If provided a name, but no format, for a transcoded input, it
includes all the nodes that use inputs with that name, otherwise it
matches to the fully-qualified name only (i.e. name@format).
Parameters:
-
*inputs(str, default:()) –A list of inputs which should be used as a starting point of the new
Pipeline.
Raises:
-
ValueError–Raised when any of the given inputs do not exist in the
Pipelineobject.
Returns:
-
Pipeline–A new
Pipelineobject, containing a subset of the nodes of the current one such that only nodes depending directly on the provided inputs are being copied.
Source code in kedro/pipeline/pipeline.py
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 | |
only_nodes_with_namespaces ¶
only_nodes_with_namespaces(node_namespaces)
Creates a new Pipeline containing only nodes with the specified
namespaces.
Parameters:
-
node_namespaces(list[str]) –A list of node namespaces.
Raises:
-
ValueError–When pipeline contains no nodes with the specified namespaces.
Returns:
-
Pipeline–A new
Pipelinecontaining nodes with the specified namespaces.
Source code in kedro/pipeline/pipeline.py
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 | |
only_nodes_with_outputs ¶
only_nodes_with_outputs(*outputs)
Create a new Pipeline object with the nodes which are directly
required to produce the provided outputs.
If provided a name, but no format, for a transcoded dataset, it
includes all the nodes that output to that name, otherwise it matches
to the fully-qualified name only (i.e. name@format).
Parameters:
-
*outputs(str, default:()) –A list of outputs which should be the final outputs of the new
Pipeline.
Raises:
-
ValueError–Raised when any of the given outputs do not exist in the
Pipelineobject.
Returns:
-
Pipeline–A new
Pipelineobject, containing a subset of the nodes of the -
Pipeline–current one such that only nodes which are directly required to
-
Pipeline–produce the provided outputs are being copied.
Source code in kedro/pipeline/pipeline.py
842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 | |
only_nodes_with_tags ¶
only_nodes_with_tags(*tags)
Creates a new Pipeline object with the nodes which contain any
of the provided tags. The resulting Pipeline is empty if no tags
are provided.
Parameters:
-
*tags(str, default:()) –A list of node tags which should be used to lookup the nodes of the new
Pipeline.
Returns:
Pipeline: A new Pipeline object, containing a subset of the
nodes of the current one such that only nodes containing any
of the tags provided are being copied.
Source code in kedro/pipeline/pipeline.py
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 | |
outputs ¶
outputs()
The names of outputs produced when the whole pipeline is run. Does not include intermediate outputs that are consumed by other pipeline nodes. Resolves transcoded names where necessary.
Returns:
-
set[str]–The set of final pipeline outputs.
Source code in kedro/pipeline/pipeline.py
440 441 442 443 444 445 446 447 448 449 | |
tag ¶
tag(tags)
Tags all the nodes in the pipeline.
Parameters:
-
tags(str | Iterable[str]) –The tags to be added to the nodes.
Returns:
-
Pipeline–New
Pipelineobject with nodes tagged.
Source code in kedro/pipeline/pipeline.py
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 | |
to_json ¶
to_json()
Return a json representation of the pipeline.
Source code in kedro/pipeline/pipeline.py
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 | |
to_nodes ¶
to_nodes(*node_names)
Create a new Pipeline object with the nodes required directly
or transitively by the provided nodes.
Parameters:
-
*node_names(str, default:()) –A list of node_names which should be used as an end point of the new
Pipeline.
Raises:
ValueError: Raised when any of the given names do not exist in the
Pipeline object.
Returns:
A new Pipeline object, containing a subset of the nodes of the
current one such that only nodes required directly or
transitively by the provided nodes are being copied.
Source code in kedro/pipeline/pipeline.py
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 | |
to_outputs ¶
to_outputs(*outputs)
Create a new Pipeline object with the nodes which are directly
or transitively required to produce the provided outputs.
If provided a name, but no format, for a transcoded dataset, it
includes all the nodes that output to that name, otherwise it matches
to the fully-qualified name only (i.e. name@format).
Parameters:
-
*outputs(str, default:()) –A list of outputs which should be the final outputs of the new
Pipeline.
Raises:
-
ValueError–Raised when any of the given outputs do not exist in the
Pipelineobject.
Returns:
-
Pipeline–A new
Pipelineobject, containing a subset of the nodes of the -
Pipeline–current one such that only nodes which are directly or transitively
-
Pipeline–required to produce the provided outputs are being copied.
Source code in kedro/pipeline/pipeline.py
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 | |
SequentialRunner ¶
SequentialRunner(is_async=False)
Bases: AbstractRunner
SequentialRunner is an AbstractRunner implementation. It can
be used to run the Pipeline in a sequential manner using a
topological sort of provided nodes.
Parameters:
-
is_async(bool, default:False) –If True, the node inputs and outputs are loaded and saved asynchronously with threads. Defaults to False.
Source code in kedro/runner/sequential_runner.py
25 26 27 28 29 30 31 32 33 34 35 | |
SharedMemoryDataCatalog ¶
SharedMemoryDataCatalog(datasets=None, config_resolver=None, load_versions=None, save_version=None)
Bases: DataCatalog
A specialized DataCatalog for managing datasets in a shared memory context.
The SharedMemoryDataCatalog extends the base DataCatalog to support multiprocessing
by ensuring that datasets are serializable and synchronized across threads or processes.
It provides additional functionality for managing shared memory datasets, such as setting
a multiprocessing manager and validating dataset compatibility with multiprocessing.
Attributes:
-
default_runtime_patterns(ClassVar) –A dictionary defining the default runtime pattern for datasets of type
kedro.io.SharedMemoryDataset.
Example:
from multiprocessing.managers import SyncManager
from kedro.io import MemoryDataset
from kedro.io.data_catalog import SharedMemoryDataCatalog
# Create a shared memory catalog
catalog = SharedMemoryDataCatalog(
datasets={"shared_data": MemoryDataset(data=[1, 2, 3])}
)
# Set a multiprocessing manager
manager = SyncManager()
manager.start()
catalog.set_manager_datasets(manager)
# Validate the catalog for multiprocessing compatibility
catalog.validate_catalog()
Source code in kedro/io/data_catalog.py
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | |
set_manager_datasets ¶
set_manager_datasets(manager)
Associate a multiprocessing manager with all shared memory datasets in the catalog.
This method iterates through all datasets in the catalog and sets the provided
multiprocessing manager for datasets of type SharedMemoryDataset. This ensures
that these datasets are properly synchronized across threads or processes.
Parameters:
-
manager(SyncManager) –A multiprocessing manager to be associated with shared memory datasets.
Example:
from multiprocessing.managers import SyncManager
from kedro.io.data_catalog import SharedMemoryDataCatalog
catalog = SharedMemoryDataCatalog(datasets={"shared_data": MemoryDataset(data=[1, 2, 3])})
manager = SyncManager()
manager.start()
catalog.set_manager_datasets(manager)
print(catalog)
# {'shared_data': kedro.io.memory_dataset.MemoryDataset(data='<list>')}
Source code in kedro/io/data_catalog.py
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 | |
validate_catalog ¶
validate_catalog()
Validate the catalog to ensure all datasets are serializable and compatible with multiprocessing.
This method checks that all datasets in the catalog are serializable and do not include non-proxied memory datasets as outputs. Non-serializable datasets or datasets that rely on single-process memory cannot be used in a multiprocessing context. If any such datasets are found, an exception is raised with details.
Raises:
-
AttributeError–If any datasets are found to be non-serializable or incompatible with multiprocessing.
Example:
from kedro.io.data_catalog import SharedMemoryDataCatalog
catalog = SharedMemoryDataCatalog(datasets={"shared_data": MemoryDataset(data=[1, 2, 3])})
try:
catalog.validate_catalog()
except AttributeError as e:
print(f"Validation failed: {e}")
# No error
Source code in kedro/io/data_catalog.py
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 | |
_create_hook_manager ¶
_create_hook_manager()
Create a new PluginManager instance and register Kedro's hook specs.
Source code in kedro/framework/hooks/manager.py
26 27 28 29 30 31 32 33 34 35 36 37 38 | |
_describe_git ¶
_describe_git(project_path)
Source code in kedro/framework/session/session.py
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | |
_jsonify_cli_context ¶
_jsonify_cli_context(ctx)
Source code in kedro/framework/session/session.py
69 70 71 72 73 74 75 | |
_register_hooks ¶
_register_hooks(hook_manager, hooks)
Register all hooks as specified in hooks with the global hook_manager.
Parameters:
-
hook_manager(PluginManager) –Hook manager instance to register the hooks with.
-
hooks(Iterable[Any]) –Hooks that need to be registered.
Source code in kedro/framework/hooks/manager.py
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | |
_register_hooks_entry_points ¶
_register_hooks_entry_points(hook_manager, disabled_plugins)
Register pluggy hooks from python package entrypoints.
Parameters:
-
hook_manager(PluginManager) –Hook manager instance to register the hooks with.
-
disabled_plugins(Iterable[str]) –An iterable returning the names of plugins which hooks must not be registered; any already registered hooks will be unregistered.
Source code in kedro/framework/hooks/manager.py
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 102 103 104 105 106 107 | |
find_kedro_project ¶
find_kedro_project(current_dir)
Given a path, find a Kedro project associated with it.
Can be
- Itself, if a path is a root directory of a Kedro project.
- One of its parents, if self is not a Kedro project but one of the parent path is.
- None, if neither self nor any parent path is a Kedro project.
Returns:
-
Any–Kedro project associated with a given path,
-
Any–or None if no relevant Kedro project is found.
Source code in kedro/utils.py
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | |
generate_timestamp ¶
generate_timestamp()
Generate the timestamp to be used by versioning.
Returns:
-
str–String representation of the current timestamp.
Source code in kedro/io/core.py
481 482 483 484 485 486 487 488 489 | |
get_close_matches ¶
get_close_matches(input, targets, max_suggestions=3, cutoff=0.6)
Get close matches from targets for inputs.
Parameters:
-
input(str | list[str]) –Inputs to get close matches for as a single string or list of strings.
-
targets(Iterable[str]) –Targets to get close matches from as a list of strings.
-
max_suggestions(int, default:3) –Maximum number of suggestions to return, defaults to 3.
-
cutoff(float, default:0.6) –Cutoff value for the similarity ratio, defaults to 0.6.
Returns: List of close matches or empty list if no matches are found.
Source code in kedro/utils.py
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | |
validate_settings ¶
validate_settings()
Eagerly validate that the settings module is importable if it exists. This is desirable to
surface any syntax or import errors early. In particular, without eagerly importing
the settings module, dynaconf would silence any import error (e.g. missing
dependency, missing/mislabelled pipeline), and users would instead get a cryptic
error message Expected an instance of `ConfigLoader`, got `NoneType` instead.
More info on the dynaconf issue: https://github.com/dynaconf/dynaconf/issues/460
Source code in kedro/framework/project/__init__.py
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 | |
kedro.framework.session.store ¶
This module implements a dict-like store object used to persist Kedro sessions.
BaseSessionStore ¶
BaseSessionStore(path, session_id)
Bases: UserDict
BaseSessionStore is the base class for all session stores.
BaseSessionStore is an ephemeral store implementation that doesn't
persist the session data.
Source code in kedro/framework/session/store.py
16 17 18 19 | |
read ¶
read()
Read the data from the session store.
Returns:
-
dict[str, Any]–A mapping containing the session store data.
Source code in kedro/framework/session/store.py
25 26 27 28 29 30 31 32 33 34 35 | |
save ¶
save()
Persist the session store
Source code in kedro/framework/session/store.py
37 38 39 40 41 42 | |