Sagemaker docs #182
Sagemaker docs #182
Conversation
Link Check Report
2/52 links failed.
|
| more about SageMaker | ||
| [here](https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html). | ||
|
|
||
| ### Preparing infrastructre |
There was a problem hiding this comment.
typo., could you please run Grammarly or something on top of the text? (I see other typos, English syntax mistakes, etc)
There was a problem hiding this comment.
I use Code Spell Checker on VS Code and it helps fix typos, which is often ~ 80% of the problem.
I've just recently started trying Grammarly too so I'm not yet sure whether to recommend it. But it can certainly help improve syntax marginally at least for some people.
There was a problem hiding this comment.
Also, I'd call this section
| ### Preparing infrastructre | |
| ## Prerequisites |
so it's more general (applicable to all pages)
| MLEM SageMaker allow you to deploy MLEM models to AWS SageMaker. You can learn | ||
| more about SageMaker | ||
| [here](https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html). |
There was a problem hiding this comment.
This should be the intro sentence TBH (before Description or maybe we don't even need a ## Description header (maybe thus move this one change to #179?).
We can condense it even more too:
| MLEM SageMaker allow you to deploy MLEM models to AWS SageMaker. You can learn | |
| more about SageMaker | |
| [here](https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html). | |
| This extension allows you to deploy MLEM models to AWS [SageMaker]. | |
| [sagemaker]: https://docs.aws.amazon.com/sagemaker/latest/dg/whatis.html |
One question on terminology though: is "MLEM model" the same as "MLEM model object"? Also sounds a lot like "ML model". We have to think this through so it's clear, I think. Maybe phrase it as deploy Ml models from MLEM to
|
Before reviewing this more. Are you still planning to put this on top of #179? Per recent discussions there (at least my recommendation is that) maybe we should separate these explanations from the more technical/formal references and thus this would be part of the User Guide while the rest is in a new Object Reference section (inter-linked). |
|
Let's resolve where we put what first, yes. But in terms of content I will of course re-use this |
|
So the next step here would be to go back to #179 (comment) and further comments, I think? |
|
@jorgeorpinel @mike0sv, I'm closing this PR, since we decided that everything should be done in #188. @jorgeorpinel, I'll use your feedback above for #188. |
Docs structure overhaul as discussed in #179 This PR is meant to replace #179 and #182 What was done: - Created subpages for all major features (models/data/serving/building/deploy) in user-guide for each - Moved there hand-crafted documentation from extension docs in #179 - index pages are from GS - Renamed Extension section into Object Reference - restructured it. was: `<ext type>/<ext name>`, now: `<object group>/<ext name>`. Now multipurpose extensions (eg docker has build & deploy) has two pages - Object Reference is now fully autogenerated - Added builtin implementations there too - Moved details about mlem abcs and mlem objects from UG - Rewritten GS - New User Guide pages - New Object reference index pages written - Use Cases cleaned up TODO: - [x] rewrite GS Deployment - [x] rewrite UG Deployment (+ explain what State is) - [x] update UG Heroku - [x] merge UG K8s @madhur-tandon - [x] update UG Sagemaker - @mike0sv, [there are your TODOs left](https://mlem-ai-new-docs-struct-hy95mv.herokuapp.com/doc/user-guide/deploying/sagemaker) - [x] write UG Docker @madhur-tandon - [x] update CLI reference - [x] update API reference - [x] merge UG export to venvs @madhur-tandon - [x] rewrite Project structure - [x] update UC - remote `.mlem/` dir and `mlem.api.ls` mentions - [x] search and remove all other mentions of `.mlem/` dir and `mlem.api.ls` - [x] search and update all other mentions of `mlem init` - [x] search and update all other mentions of `--conf` or `-c` - [x] fix broken links @madhur-tandon - [x] add `mlem checkenv` to command reference. Why it wasn't generated I wonder?
jorgeorpinel
added
A: docs
Chaining this to #179
Adds documentation for SageMaker deployments
In review app: https://mlem-ai-feature-sagemak-eono3p.herokuapp.com/doc/extensions/deployment/sagemaker