-
Notifications
You must be signed in to change notification settings - Fork 133
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updates doc string to show example usage.
- Loading branch information
Showing
6 changed files
with
320 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Example showing graph validation | ||
|
||
This uses the StaticValidator class to validate a graph. | ||
|
||
This specifically show how, for example, you can validate tags on functions. | ||
|
||
- run.py shows the validator and how to wire it in | ||
- good_module.py shows a node with the correct tags | ||
- bad_module.py shows a node with the wrong tags | ||
- notebook.ipynb shows how to run the same code in a notebook | ||
|
||
To run the example, run `python run.py` and you should see the following output: | ||
|
||
``` | ||
# good_module.py ran | ||
{'foo': 'Hello, world!'} | ||
# bad_module.py didn't have the right tags so graph building errored out | ||
... | ||
Hamilton.lifecycle.base.ValidationException: Node validation failed! 1 errors encountered: | ||
foo: Node bad_module.foo is an output node, but does not have a table_name tag. | ||
``` | ||
|
||
Alternatively you can run this all via the notebook.ipynb. |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
from hamilton.function_modifiers import tag | ||
|
||
|
||
@tag(node_type="output") | ||
def foo() -> str: | ||
return "Hello, world!" |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
from hamilton.function_modifiers import tag | ||
|
||
|
||
@tag(node_type="output", table_name="my_table") | ||
def foo() -> str: | ||
return "Hello, world!" |
Oops, something went wrong.