Page MenuHomePhabricator
Differential D4719

Revised the Parametrizing Solid with Config in Docs Basics of Solids
ClosedPublic
Actions

Authored by yichendai on Oct 8 2020, 3:34 AM.

Details

Reviewers
yuhan
max
sashank
schrockn
Commits
R1:bb7ab5752e47: Revised the Parametrizing Solid with Config in Docs Basics of Solids
Summary
  1. Created a new config.py for parametrizing-solids-with-config. Wrote a new config.py and its test: test_config.py.
  2. The image is modified manually. I'll update all the screenshots after learning how to use generate_screenshots.test.js

Latest Preview by 10/19 PM:

Test Plan

test_config.py

Diff Detail

Repository
R1 dagster
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
yichendai added a comment.Oct 8 2020, 6:03 AM

Update

Harbormaster returned this revision to the author for changes because remote builds failed.Oct 8 2020, 6:23 AM
Harbormaster failed remote builds in B19305: Diff 23457!
yichendai updated this revision to Diff 23482.Oct 8 2020, 5:17 PM

Update to fix error

Harbormaster returned this revision to the author for changes because remote builds failed.Oct 8 2020, 5:35 PM
Harbormaster failed remote builds in B19322: Diff 23482!
yichendai updated this revision to Diff 23492.Oct 8 2020, 7:27 PM

Update: fix errors

yichendai retitled this revision from Revised the Prametrizing Solid with Config in Docs Basics of Solids to Revised the Parametrizing Solid with Config in Docs Basics of Solids.Oct 8 2020, 7:28 PM
Harbormaster returned this revision to the author for changes because remote builds failed.Oct 8 2020, 7:46 PM
Harbormaster failed remote builds in B19331: Diff 23492!
yichendai updated this revision to Diff 23601.Oct 13 2020, 6:43 AM

Update: Created a new test for config.py

yichendai edited the test plan for this revision. (Show Details)Oct 13 2020, 6:45 AM
yichendai removed reviewers: max, yuhan, sashank.
Harbormaster returned this revision to the author for changes because remote builds failed.Oct 13 2020, 7:04 AM
Harbormaster failed remote builds in B19423: Diff 23601!
yichendai updated this revision to Diff 23701.Oct 14 2020, 5:32 PM

Update: Fix import error in test_config.py and merge conflicts

yichendai retitled this revision from Revised the Parametrizing Solid with Config in Docs Basics of Solids to [Part1] Revised the Parametrizing Solid with Config in Docs Basics of Solids.Oct 14 2020, 5:51 PM
yichendai edited the summary of this revision. (Show Details)
yichendai edited the test plan for this revision. (Show Details)
yichendai added reviewers: yuhan, max, sashank.
yichendai edited the summary of this revision. (Show Details)Oct 14 2020, 5:55 PM
yichendai edited the summary of this revision. (Show Details)
Harbormaster returned this revision to the author for changes because remote builds failed.Oct 14 2020, 5:56 PM
Harbormaster failed remote builds in B19508: Diff 23701!
yichendai edited the summary of this revision. (Show Details)Oct 14 2020, 5:58 PM
yichendai edited the summary of this revision. (Show Details)
yichendai edited the summary of this revision. (Show Details)
yichendai updated this revision to Diff 23707.Oct 14 2020, 7:19 PM
yichendai edited the summary of this revision. (Show Details)

Update: black fix formatting; update config_env.yaml

Harbormaster returned this revision to the author for changes because remote builds failed.Oct 14 2020, 7:38 PM
Harbormaster failed remote builds in B19514: Diff 23707!
yichendai updated this revision to Diff 23722.Oct 14 2020, 9:26 PM

Update: black reformat config.py

Harbormaster returned this revision to the author for changes because remote builds failed.Oct 14 2020, 9:45 PM
Harbormaster failed remote builds in B19527: Diff 23722!
yichendai updated this revision to Diff 23764.Oct 15 2020, 5:03 PM

Update: rewrite .mdx

Harbormaster completed remote builds in B19561: Diff 23764.Oct 15 2020, 5:24 PM
yichendai requested review of this revision.Oct 15 2020, 5:24 PM
yichendai retitled this revision from [Part1] Revised the Parametrizing Solid with Config in Docs Basics of Solids to Revised the Parametrizing Solid with Config in Docs Basics of Solids.Oct 15 2020, 5:31 PM
yichendai edited the summary of this revision. (Show Details)
yichendai edited the summary of this revision. (Show Details)
yichendai edited the summary of this revision. (Show Details)
yichendai added a reviewer: schrockn.Oct 15 2020, 6:07 PM
yuhan added a comment.Oct 15 2020, 9:52 PM

can you screenshot the final view of the page for reviewing?

yichendai added a comment.EditedOct 15 2020, 10:20 PM

Here're three screenshots for preview of the page.

yuhan added a comment.Oct 16 2020, 10:04 PM

would be good to show how users can specify the solid config value in [1] and [2] too as you did in the test

examples/docs_snippets/docs_snippets/intro_tutorial/basics/e02_solids/config.py
62

[1] supply run_config via python api

examples/docs_snippets/docs_snippets/intro_tutorial/basics/e02_solids/config_env.yaml
5

[2] use CLI with the yaml file

yichendai marked 2 inline comments as done.Oct 17 2020, 1:13 AM
yichendai added inline comments.
docs/next/src/pages/tutorial/basics_solids.mdx
252

appears

yichendai updated this revision to Diff 23965.Oct 17 2020, 1:25 AM
yichendai edited the summary of this revision. (Show Details)

Update: Add how to specify config by python api and yaml file

Harbormaster completed remote builds in B19745: Diff 23965.Oct 17 2020, 2:08 AM
yichendai edited the summary of this revision. (Show Details)Oct 17 2020, 2:24 AM
yuhan added a comment.Oct 17 2020, 6:02 AM

good job! this is looking a lot better

docs/next/src/pages/tutorial/basics_solids.mdx
219

could also emphasize the line with the solid config

examples/docs_snippets/docs_snippets/intro_tutorial/basics/e02_solids/config.py
14–15

after reading through the screenshot, i don't think these log information make much sense. when reverse=True, sorted_cereals[0] will be the most and sorted_cereals[-1] will be the least.

i'd suggest maybe come up with a better example semantically, for example (just throwing ideas), only printing:

context.log.info(
    "{x} caloric cereal: {least_caloric}".format(
        x='most' if reverse else 'least',
        least_caloric=sorted_cereals[0]["name"]
    )
)
yichendai updated this revision to Diff 24004.Oct 19 2020, 7:03 PM

Update: modified context.log.info and set reverse to True in config.py and its yaml

yichendai marked 2 inline comments as done.Oct 19 2020, 7:04 PM
yichendai edited the summary of this revision. (Show Details)Oct 19 2020, 7:07 PM
yichendai updated this revision to Diff 24006.Oct 19 2020, 7:09 PM

Update: fix typo

yichendai edited the summary of this revision. (Show Details)Oct 19 2020, 7:12 PM
Harbormaster completed remote builds in B19783: Diff 24004.Oct 19 2020, 7:24 PM
schrockn requested changes to this revision.Oct 19 2020, 7:26 PM

This is great! Some minor feedback. Big improvement

docs/next/src/pages/tutorial/basics_solids.mdx
189

We shouldn't wrap the description in a tuple

196

we may want to note here that they can optionally be *only* the type if you do not require changes to other defaults.

In fact we may want to consider starting with:

@solid(config_schema={"reverse" : bool})

Because it is less verbose, and then explain how we can opt into descriptions and default values and required

This revision now requires changes to proceed.Oct 19 2020, 7:26 PM
Harbormaster failed remote builds in B19785: Diff 24006!Oct 19 2020, 7:30 PM
yichendai updated this revision to Diff 24052.Oct 20 2020, 12:46 AM

Update: Start with the least verbose config example

yichendai marked 2 inline comments as done.EditedOct 20 2020, 12:49 AM

The config.py contains the least verbose example.

Created another config_more_details.py to hold the optional config.

yichendai edited the summary of this revision. (Show Details)Oct 20 2020, 12:52 AM
yichendai edited the summary of this revision. (Show Details)
yichendai edited the summary of this revision. (Show Details)
Harbormaster completed remote builds in B19825: Diff 24052.Oct 20 2020, 1:09 AM
schrockn accepted this revision.EditedOct 20 2020, 3:24 PM

awesome! looking forward to seeing this pushed

docs/next/src/pages/tutorial/basics_solids.mdx
231–233

It might be worth nothing here that bool is automatically coerced to Field(Bool) and is precisely equivalent

This revision is now accepted and ready to land.Oct 20 2020, 3:24 PM
yichendai marked an inline comment as done.Oct 21 2020, 12:23 AM

yichendai updated this revision to Diff 24166.Oct 21 2020, 2:40 AM
yichendai edited the summary of this revision. (Show Details)

Update last fix

Harbormaster completed remote builds in B19915: Diff 24166.Oct 21 2020, 3:00 AM
Closed by commit R1:bb7ab5752e47: Revised the Parametrizing Solid with Config in Docs Basics of Solids (authored by yichendai). · Explain WhyOct 21 2020, 3:20 AM
This revision was automatically updated to reflect the committed changes.
yichendai added a commit: R1:bb7ab5752e47: Revised the Parametrizing Solid with Config in Docs Basics of Solids.

Revision Contents
Changeset List

PathSize
docs/
next/
public/
assets/
images/
tutorial/
src/
pages/
tutorial/
103 lines
examples/
docs_snippets/
docs_snippets/
intro_tutorial/
basics/
e02_solids/
140 lines
config_env.yaml
config_env_bad.yaml
5 lines
69 lines
docs_snippets_tests/
intro_tutorial_tests/
basics/
66 lines
12 lines

Diff 24171

View Options

docs/next/public/assets/images/tutorial/config_figure_one.png

Loading...
View Options

docs/next/public/assets/images/tutorial/config_figure_two.png

Loading...
View Options

docs/next/src/pages/tutorial/basics_solids.mdx

Loading...
View Options

examples/docs_snippets/docs_snippets/intro_tutorial/basics/e02_solids/config.py

Loading...
View Options

examples/docs_snippets/docs_snippets/intro_tutorial/basics/e02_solids/config_env.yaml

Loading...
View Options

examples/docs_snippets/docs_snippets/intro_tutorial/basics/e02_solids/config_env_bad.yaml

Loading...
View Options

examples/docs_snippets/docs_snippets/intro_tutorial/basics/e02_solids/config_more_details.py

Loading...
View Options

examples/docs_snippets/docs_snippets_tests/intro_tutorial_tests/basics/test_config.py

Loading...
View Options

examples/docs_snippets/docs_snippets_tests/intro_tutorial_tests/test_cli_invocations.py

Loading...