Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

Misc. docs improvements #68

Merged
merged 9 commits into from
May 30, 2022
Merged

Misc. docs improvements #68

merged 9 commits into from
May 30, 2022

Conversation

jorgeorpinel
Copy link
Contributor

@jorgeorpinel jorgeorpinel commented May 24, 2022

Continues misc. quality improvements from #43 (comment)

Main updates:

  • Consistent use of .mlem/ vs. .mlem
  • Better intros and folded CLI samples in Get Started pages [partial]
  • Removes some more unnecessary notes (md block quotes)
  • Removes unused datasets and remote-repos guide pages
  • Use term "MLEM project" instead of "repo" [partial]
  • Consistent use of terms "metadata" (generic) and "metafile" (MLEM-specific)

@gatsby-cloud
Copy link

gatsby-cloud bot commented May 24, 2022

Gatsby Cloud Build Report

mlem.ai

🎉 Your build was successful! See the Deploy preview here.

Build Details

View the build logs here.

🕐 Build time: 56s

Performance

Lighthouse report

Metric Score
Performance 💚 95
Accessibility 🔶 88
Best Practices 💚 100
SEO 🔶 83

🔗 View full report

@jorgeorpinel jorgeorpinel changed the title More docs guide: /datasets and /remote-repos, etc. May 24, 2022
@jorgeorpinel jorgeorpinel changed the title guide: /datasets and /remote-repos, etc. More docs ... May 24, 2022
@jorgeorpinel jorgeorpinel self-assigned this May 24, 2022
@jorgeorpinel jorgeorpinel changed the title More docs ... Misc. docs improvements May 24, 2022
@jorgeorpinel jorgeorpinel marked this pull request as ready for review May 24, 2022 09:45
@jorgeorpinel
Copy link
Contributor Author

Not sure who to ask for docs reviews in the MLEM team. Should I go with @aguschin normally? Alternate with @mike0sv ? Assign the whole GH team? Thanks

@aguschin
Copy link
Contributor

Please assign me, @jorgeorpinel, I think it will be more consistent :)

@aguschin aguschin self-requested a review May 25, 2022 10:00
@aguschin
Copy link
Contributor

Should I go ahead and review this or should I wait until you complete other items? @jorgeorpinel

@jorgeorpinel
Copy link
Contributor Author

Thanks and please go ahead @aguschin .

I don't think I'll have time to finish those tasks throughout the entire docs soon, which is why I marked this from draft to ready-for-review 🙂

Copy link
Contributor Author

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

To match #79 (comment) (committing)

content/docs/use-cases/dvc.md Outdated Show resolved Hide resolved
content/docs/use-cases/dvc.md Outdated Show resolved Hide resolved
content/docs/use-cases/dvc.md Outdated Show resolved Hide resolved
Copy link
Contributor

@aguschin aguschin left a comment

Choose a reason for hiding this comment

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

Great work, @jorgeorpinel! Should we merge this or you want to complete your items before that?

@@ -58,8 +58,8 @@ command.
'pandas']. Defaults to auto-infer.
- `copy_data` (optional) - Whether to create a copy of file in target location
or just link existing file. Defaults to True.
- `external` (optional) - Save result not in `.mlem`, but directly in repo
- `index` (optional) - Whether to index output in `.mlem` directory
- `external` (optional) - Save result directly in repo (not in `.mlem/`)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- `external` (optional) - Save result directly in repo (not in `.mlem/`)
- `external` (optional) - Save result directly to `target` (not in `.mlem/`)

This is more correct, since with external=True it doesn't take into account the MLEM project at all. Also, it's not repo, it's project now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah you should've felt free to commit your fixes too 🙂 but anyway, we'll get to it... ⌛

which can then be used in future operations such as `mlem apply`.
Use `import` on an existing datasets or model files (or directories) to generate
the necessary `.mlem` metafiles for them. This is useful to quickly make
existing datasets and model files compatible with MLEM, which can then be used
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
existing datasets and model files compatible with MLEM, which can then be used
existing datasets and model files compatible with MLEM, which then can be used

?

containing the model binary and `.mlem` file containing metadata. Let's take a
look at it:
The model was saved along with some metadata about it: `rf` containing the model
binary and a `.mlem` metafile containing information about it. Let's take a look
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
binary and a `.mlem` metafile containing information about it. Let's take a look
binary and a `rf.mlem` metafile containing information about it. Let's take a look

@@ -49,7 +49,7 @@ $ mlem config set default_storage.type dvc
```

Also, let’s add `.mlem` files to `.dvcignore` so that metafiles are ignored by
DVC
Copy link
Contributor

Choose a reason for hiding this comment

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

This needs to be updated due to #79

@madhur-tandon madhur-tandon mentioned this pull request May 29, 2022
2 tasks
@aguschin aguschin merged commit e48e5d1 into main May 30, 2022
@aguschin aguschin deleted the docs-content branch May 30, 2022 10:43
@aguschin
Copy link
Contributor

@jorgeorpinel, I've merged this PR. Please feel free to continue the discussion/improvements once you have some time!

@jorgeorpinel
Copy link
Contributor Author

Thanks! I'm catching up 😬

@jorgeorpinel jorgeorpinel added the A: docs Area: user documentation (gatsby-theme-iterative) label Dec 2, 2022
@jorgeorpinel jorgeorpinel added the type: enhancement Something is not clear, small updates, improvement suggestions label Dec 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A: docs Area: user documentation (gatsby-theme-iterative) type: enhancement Something is not clear, small updates, improvement suggestions
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants