Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document flytekit remote module #564

Merged
merged 4 commits into from
Jul 26, 2021
Merged

document flytekit remote module #564

merged 4 commits into from
Jul 26, 2021

Conversation

cosmicBboy
Copy link
Contributor

Signed-off-by: cosmicBboy [email protected]

TL;DR

  • Add documentation for remote module
  • change FlyteRemote.from_environment to from_config
  • add @property vars for FlyteRemote properties
  • improve doc strings
  • add a little more content to flytekit home page

Type

  • Bug Fix
  • Feature
  • Plugin
  • Docs

Are all requirements met?

  • Code completed
  • Smoke tested
  • Unit tests added
  • Code documentation added
  • Any pending items have an associated Issue

Tracking Issue

NA

Follow-up issue

NA
OR
https://github.com/lyft/flyte/issues/

@codecov
Copy link

codecov bot commented Jul 23, 2021

Codecov Report

Merging #564 (0428362) into master (8c6764c) will decrease coverage by 0.01%.
The diff coverage is 72.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #564      +/-   ##
==========================================
- Coverage   85.46%   85.45%   -0.02%     
==========================================
  Files         376      376              
  Lines       29158    29225      +67     
  Branches     2338     2347       +9     
==========================================
+ Hits        24921    24975      +54     
- Misses       3606     3615       +9     
- Partials      631      635       +4     
Impacted Files Coverage Δ
flytekit/remote/__init__.py 100.00% <ø> (ø)
flytekit/remote/component_nodes.py 69.84% <ø> (ø)
flytekit/remote/launch_plan.py 72.34% <ø> (ø)
flytekit/remote/nodes.py 69.04% <ø> (ø)
flytekit/remote/tasks/executions.py 68.18% <ø> (ø)
flytekit/remote/tasks/task.py 95.65% <ø> (ø)
flytekit/remote/workflow.py 61.53% <ø> (ø)
flytekit/remote/workflow_execution.py 72.72% <ø> (ø)
flytekit/remote/remote.py 74.11% <69.64%> (+0.60%) ⬆️
tests/flytekit/integration/remote/test_remote.py 87.69% <90.90%> (+0.19%) ⬆️
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8c6764c...0428362. Read the comment docs.

katrogan
katrogan previously approved these changes Jul 23, 2021
docs/source/design/control_plane.rst Show resolved Hide resolved
flytekit/remote/remote.py Outdated Show resolved Hide resolved
- add debug logging info for project/domain override
- update docs

Signed-off-by: cosmicBboy <[email protected]>
katrogan
katrogan previously approved these changes Jul 26, 2021
Copy link
Contributor

@katrogan katrogan left a comment

Choose a reason for hiding this comment

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

lgtm, just some nits - sorry!

docs/source/design/control_plane.rst Show resolved Hide resolved
flytekit/remote/remote.py Outdated Show resolved Hide resolved
flytekit/remote/remote.py Outdated Show resolved Hide resolved
flytekit/remote/remote.py Show resolved Hide resolved
flytekit/remote/remote.py Outdated Show resolved Hide resolved
Signed-off-by: cosmicBboy <[email protected]>
@cosmicBboy
Copy link
Contributor Author

oh shoot, sorry for being annoying, i didn't realize how many places flyte_id_kwargs were being used as a dict

no worries!

@cosmicBboy cosmicBboy merged commit ccaac7d into master Jul 26, 2021
@cosmicBboy cosmicBboy deleted the docs/flytekit-remote branch July 26, 2021 18:28
kumare3 pushed a commit that referenced this pull request Jul 31, 2021
* document flytekit remote module

Signed-off-by: cosmicBboy <[email protected]>

* execute method supports project/domain override

- add debug logging info for project/domain override
- update docs

Signed-off-by: cosmicBboy <[email protected]>

* update doc-requirements.txt

Signed-off-by: cosmicBboy <[email protected]>

* address nits

Signed-off-by: cosmicBboy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants