Skip to content
This repository has been archived by the owner on Sep 13, 2023. It is now read-only.

Remove cli examples and add link to docs page #408

Merged
merged 12 commits into from
Oct 5, 2022

Conversation

aguschin
Copy link
Contributor

close #387

$ mlem clone --help

 Usage: mlem clone [options] uri target

 Copy a MLEM Object from `uri` and saves a copy of it to `target` path.
 Documentation: <https://mlem.ai/doc/command-reference/clone>

╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *    uri         TEXT  URI to object you want to clone [default: None] [required]                                                                    │
│ *    target      TEXT  Path to store the downloaded object. [default: None] [required]                                                               │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --project              -p                TEXT  Path to MLEM project [default: (none)]                                                                │
│ --rev                                    TEXT  Repo revision to use [default: (none)]                                                                │
│ --target-project,--tp                    TEXT  Project to save target to [default: (none)]                                                           │
│ --external             -e                      Save result not in .mlem, but directly in project                                                     │
│ --index                    --no-index          Whether to index output in .mlem directory [default: no-index]                                        │
│ --help                 -h                      Show this message and exit.                                                                           │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Look like it works (maybe need to fix tests), except for groups the link to documentation is incorrect (for mlem deploy apply it's https://mlem.ai/doc/command-reference/apply

Looking into how to fix this.

@aguschin aguschin requested a review from a team as a code owner September 15, 2022 12:30
@aguschin aguschin self-assigned this Sep 15, 2022
@aguschin aguschin temporarily deployed to internal September 15, 2022 12:30 Inactive
@aguschin aguschin mentioned this pull request Sep 15, 2022
@codecov
Copy link

codecov bot commented Sep 15, 2022

Codecov Report

Base: 82.31% // Head: 87.91% // Increases project coverage by +5.59% 🎉

Coverage data is based on head (355f794) compared to base (15bf4bc).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@                Coverage Diff                @@
##           release/0.3.0     #408      +/-   ##
=================================================
+ Coverage          82.31%   87.91%   +5.59%     
=================================================
  Files                 92       92              
  Lines               7828     7839      +11     
=================================================
+ Hits                6444     6892     +448     
+ Misses              1384      947     -437     
Impacted Files Coverage Δ
mlem/cli/apply.py 94.23% <ø> (ø)
mlem/cli/build.py 100.00% <ø> (ø)
mlem/cli/checkenv.py 100.00% <ø> (ø)
mlem/cli/clone.py 100.00% <ø> (ø)
mlem/cli/config.py 95.55% <ø> (ø)
mlem/cli/declare.py 87.27% <ø> (ø)
mlem/cli/deployment.py 89.13% <ø> (ø)
mlem/cli/dev.py 50.00% <ø> (ø)
mlem/cli/import_object.py 100.00% <ø> (ø)
mlem/cli/info.py 97.56% <ø> (ø)
... and 32 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@aguschin aguschin temporarily deployed to internal September 15, 2022 13:02 Inactive
@aguschin

This comment was marked as resolved.

@aguschin
Copy link
Contributor Author

Finally works, except for few things that should be handled outside of this PR to enable merging this one:

  1. dev find-implementations-diff for now I put a link to contributing section, but it's not a helpful one docs: help for dev find-implementations-diff mlem.ai#180
  2. No reference pages for deployment wait, config (set / get), checkenv. The last two should be added in https://github.com/iterative/mlem.ai/pull/172/files as I see. deployment wait should be added to that PR as well.

@aguschin aguschin temporarily deployed to internal September 19, 2022 12:13 Inactive
@aguschin aguschin temporarily deployed to internal September 19, 2022 12:15 Inactive
@aguschin
Copy link
Contributor Author

@mike0sv, ready for review (with the exceptions I mentioned in the last message ^). Posting couple of examples. Note, in all "Documentation" line is highlighted a bit darker than other text and than in mlem -h. Can change this, but thought it's ok to keep it not that visible.

Screen Shot 2022-09-19 at 15 15 08

Screen Shot 2022-09-19 at 15 15 50

mlem/cli/config.py Outdated Show resolved Hide resolved
mlem/cli/main.py Outdated Show resolved Hide resolved
@aguschin aguschin temporarily deployed to internal September 21, 2022 12:52 Inactive
@aguschin aguschin temporarily deployed to internal September 21, 2022 12:55 Inactive
@mike0sv mike0sv temporarily deployed to internal October 3, 2022 15:43 Inactive
@mike0sv
Copy link
Contributor

mike0sv commented Oct 3, 2022

I fixed some of the tests. Need to adopt #427 changes.
And probably mark doc links tests as xfail for now?

@jorgeorpinel jorgeorpinel added A: docs DEPRECATED Area: user documentation; See github.com/iterative/mlem.ai/labels/A%3A%20docs ux Things that matter for user experience labels Oct 3, 2022
@aguschin aguschin temporarily deployed to internal October 5, 2022 04:27 Inactive
@aguschin
Copy link
Contributor Author

aguschin commented Oct 5, 2022

And probably mark doc links tests as xfail for now?

Possible, but right after the update docs, we need to remove this xfail mark. Added xfail mark and mentioned this on the list of TODOs here #397

* fix issues with pandas pylint and flake8

* fix requirements

* fix req tests

* remove comment

* fix catboost req tests

Co-authored-by: mike0sv <[email protected]>
@aguschin aguschin temporarily deployed to internal October 5, 2022 04:31 Inactive
@aguschin aguschin merged commit 044e878 into release/0.3.0 Oct 5, 2022
@aguschin aguschin deleted the remove-cli-examples branch October 5, 2022 04:59
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: docs DEPRECATED Area: user documentation; See github.com/iterative/mlem.ai/labels/A%3A%20docs ux Things that matter for user experience
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants