Skip to content
This repository has been archived by the owner on Mar 29, 2022. It is now read-only.

[:memo:] Extend python docs with lineage tracing #134

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

phaniarnab
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@corepointer corepointer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs look good 👍
I spotted a few mistakes though which should be easy to fix.

Lineage Trace API
=================

Lineage tracing captures every instruction during runtime and store those in a DAG.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...and stores them...

=================

Lineage tracing captures every instruction during runtime and store those in a DAG.
An user can retreive the string representation of a lineage trace by enabling
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A user

Comment on lines +25 to +26
A *lineage item* is composed of an *id*, which is uniquely identifiable
through an execution, an *opcode* for identifying the physical operation,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The id is uniquely identifiable through an execution? Do you mean, that the id uniquely identifies the lineage item throughout a single execution?

Comment on lines +28 to +29
captured instruction, and a *data* attribute, which represents all necessary
information. It also stores references to other *lineage items*
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The data attribute represents all necessary information to do what? What do I need the other things like name and id for, when the data attribute represents it all?


.. note::

Lineage trace is captured during execution of an instruction in SystemDS.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lineage trace...


Lineage trace is captured during execution of an instruction in SystemDS.
That means, tracing lineage for an intermediate requires SystemDS to lazily
execute the DAG of operations till the desired node.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...until the desired node has been processed.

That means, tracing lineage for an intermediate requires SystemDS to lazily
execute the DAG of operations till the desired node.

The example below traces lineage of an DAG of operations.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a DAG

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants