New docs structure

content/docs/api-reference/build.md

@@ -1,8 +1,8 @@
 # mlem.api.build()
 
-Build a [MLEM model](/doc/user-guide/mlem-abcs#modeltype) in pip-ready format, a
-built package using whl, docker-build-ready folder or directly build a docker
-image.
+Build a [MLEM model](/doc/object-reference/mlem-abcs#modeltype) in pip-ready
+format, a built package using whl, docker-build-ready folder or directly build a
+docker image.
 
 ```py
 def build(

content/docs/api-reference/init.md

@@ -1,6 +1,7 @@
 # mlem.api.init()
 
-Creates and populates the `.mlem/` directory in `path`.
+Creates `.mlem.yaml` config file in `path`. See
+[User Guide](/doc/user-guide/configuration) for more details.
 
 ```py
 def init(path: str = ".") -> None
@@ -16,8 +17,7 @@ init(path)
 
 ## Description
 
-Initializes a MLEM project by creating a `.mlem/` directory inside the given
-path. A new and empty `config.yaml` is also created inside it.
+Initializes a MLEM project by creating a new and empty `.mlem.yaml` file.
 
 ## Parameters
 

content/docs/command-reference/apply-remote.md

@@ -1,15 +1,15 @@
 # apply-remote
 
 Apply a deployed-model (possibly remotely) to data. The results will be saved as
-a MLEM object to `output` if provided. Otherwise, it will be printed to
-`stdout`.
+a [MLEM Object](/doc/user-guide/basic-concepts) to `output` if provided.
+Otherwise, it will be printed to `stdout`.
 
 ## Synopsis
 
 ```usage
 usage: mlem apply-remote [-d <path>] [-p <path>] [--rev <commitish>]
                          [-o <path>] [--tp <path>] [-m <text>]
-                         [--index] [--json] [-f <text>] [-h]
+                         [--json] [-f <text>] [-h]
                          [<client> [client options] | --load <declaration>]
 
 Builtin clients:
@@ -39,7 +39,6 @@ clients are `http` and `rmq` - which are used to launch requests against the
   (none)]
 - `-m <text>`, `--method <text>` - Which model method is to be applied [default:
   predict]
-- `--index` / `--no-index` - Whether to index output in .mlem directory
 - `--json` - Output as json
 - `-f <text>`, `--file_conf <text>` - File with options for client in format
   `field.name=path_to_config`
@@ -53,5 +52,5 @@ this) and a local MLEM dataset `mydataset`, run the following command to infer
 the entire dataset with the model and save the output result to `myprediction`
 
 ```cli
-$ mlem apply-remote http mydataset --conf host="127.0.0.1" --conf port=3000 --output myprediction
+$ mlem apply-remote http mydataset --host="127.0.0.1" --port=3000 --output myprediction
 ```

content/docs/command-reference/apply.md

@@ -1,15 +1,16 @@
 # apply
 
-Apply a model to data. The result will be saved as a MLEM object to `output` if
-provided. Otherwise, it will be printed to `stdout`.
+Apply a model to data. The result will be saved as a
+[MLEM Object](/doc/user-guide/basic-concepts) to `output` if provided.
+Otherwise, it will be printed to `stdout`.
 
 ## Synopsis
 
 ```usage
 usage: mlem apply [-p <path>] [--rev <commitish>] [-o <path>]
-                  [-m <text>] [--dr <path>]
-                  [--data-rev <commitish>] [-i] [--it <text>]
-                  [-b <integer>] [--index] [-e] [--json] [-h]
+                  [-m <text>] [--dp <path>] [--dr <commitish>]
+                  [-i] [--it <text>] [-b <integer>] [--json]
+                  [-h]
                   model data
 
 arguments:
@@ -38,15 +39,13 @@ datasets.
 - `-o <path>`, `--output <path>` - Where to save model outputs
 - `-m <text>`, `--method <text>` - Which model method is to be applied [default:
   predict]
-- `--dr <path>`, `--data-project <path>` - Project with data
-- `--data-rev <commitish>` - Revision of data
+- `--dp <path>`, `--data-project <path>` - Project with data
+- `--dr <commitish>`, `--data-rev <commitish>` - Revision of data
 - `-i`, `--import` - Try to import data on-the-fly
 - `--it <text>`, `--import-type <text>` - Specify how to read data file for
   import. Available types: ['pandas', 'pickle', 'torch']
 - `-b <integer>`, `--batch_size <integer>` - Batch size for reading data in
   batches
-- `--index` / `--no-index` - Whether to index output in .mlem directory
-- `-e`, `--external` - Save result not in .mlem, but directly in project
 - `--json` - Output as json
 - `-h`, `--help` - Show this message and exit.
 

content/docs/command-reference/build.md

@@ -13,7 +13,6 @@ usage: mlem build [-m <path>] [-p <path>] [--rev <commitish>]
 Builtin builders:
 - docker
 - docker_dir
-- kubernetes
 - pip
 - whl
 ```
@@ -38,14 +37,14 @@ images.
 Build a Docker image from a model
 
 ```cli
-$ mlem build mymodel docker --conf server.type=fastapi --conf image.name=myimage
+$ mlem build mymodel docker --server.type=fastapi --image.name=myimage
 ```
 
 Create a `docker_dir` builder config called `build_dock`, and use it to package
 a model
 
 ```cli
-$ mlem declare builder docker_dir --conf server=fastapi --conf target=build build_dock
+$ mlem declare builder docker_dir --server=fastapi --target=build build_dock
 ...
 
 $ mlem build mymodel --load build_dock

content/docs/command-reference/checkenv.md

@@ -19,3 +19,9 @@ arguments:
 - `-h`, `--help` - Show this message and exit.
 
 ## Examples
+
+```cli
+$ mlem checkenv rf
+⏳️ Loading meta from rf.mlem
+✅  Requirements are satisfied!
+```

content/docs/command-reference/clone.md

@@ -1,13 +1,13 @@
 # clone
 
-Copy a [MLEM Object](/doc/user-guide/basic-concepts#mlem-objects) from `uri` and
-saves a copy of it to `target` path.
+Copy a [MLEM Object](/doc/user-guide/basic-concepts) from `uri` and saves a copy
+of it to `target` path.
 
 ## Synopsis
 
 ```usage
 usage: mlem clone [-p <path>] [--rev <commitish>]
-                  [--tp <path>] [-e] [--index] [-h]
+                  [--tp <path>] [-h]
                   uri target
 
 arguments:
@@ -28,8 +28,6 @@ repository.
 - `--rev <commitish>` - Repo revision to use [default: (none)]
 - `--tp <path>`, `--target-project <path>` - Project to save target to [default:
   (none)]
-- `-e`, `--external` - Save result not in .mlem, but directly in project
-- `--index` / `--no-index` - Whether to index output in .mlem directory
 - `-h`, `--help` - Show this message and exit.
 
 ## Examples

content/docs/command-reference/declare.md

@@ -1,7 +1,7 @@
 # declare
 
-Declares a new [MLEM Object](/doc/user-guide/basic-concepts#mlem-objects)
-metafile from config args and config files.
+Declares a new [MLEM Object](/doc/user-guide/basic-concepts)
+[MLEM Object](/doc/user-guide/basic-concepts) from config args and config files.
 
 ## Synopsis
 
@@ -45,10 +45,10 @@ $ mlem types env heroku
 
 # Declare the heroku env
 $ mlem declare env heroku production --api_key mlem_heroku_staging
-💾 Saving env to .mlem/env/staging.mlem
+💾 Saving env to staging.mlem
 
 # Print the contents of the new heroku env metafile
-$ cat .mlem/env/staging.mlem
+$ cat staging.mlem
 api_key: mlem_heroku_staging
 object_type: env
 type: heroku

content/docs/command-reference/deployment/apply.md

@@ -6,9 +6,8 @@ Apply a deployed model to data.
 
 ```usage
 usage: mlem deployment apply [-p <path>] [--rev <commitish>]
-                             [--dr <path>] [--data-rev <commitish>]
-                             [-o <text>] [--tp <path>] [-m <text>]
-                             [--index] [--json] [-h]
+                             [--dp <path>] [--dr <commitish>] [-o <text>]
+                             [--tp <path>] [-m <text>] [--json] [-h]
                              path data
 
 arguments:
@@ -27,14 +26,13 @@ gathered and returned, also as a MLEM Object.
 
 - `-p <path>`, `--project <path>` - Path to MLEM project [default: (none)]
 - `--rev <commitish>` - Repo revision to use [default: (none)]
-- `--dr <path>`, `--data-project <path>` - Project with data
-- `--data-rev <commitish>` - Revision of data
+- `--dp <path>`, `--data-project <path>` - Project with data
+- `--dr <commitish>`, `--data-rev <commitish>` - Revision of data
 - `-o <text>`, `--output <text>` - Where to store the outputs.
 - `--tp <path>`, `--target-project <path>` - Project to save target to [default:
   (none)]
 - `-m <text>`, `--method <text>` - Which model method is to be applied [default:
   predict]
-- `--index` / `--no-index` - Whether to index output in .mlem directory
 - `--json` - Output as json
 - `-h`, `--help` - Show this message and exit.
 

content/docs/command-reference/deployment/index.md

@@ -9,11 +9,11 @@ usage: mlem deployment [-h]
                        command
 
 subcommands:
-  run              Deploy a model to a target environment.
   remove           Stop and destroy deployed instance.
   status           Print status of deployed service.
   wait             Wait for status of deployed service
   apply            Apply a deployed model to data.
+  run              Deploy a model to a target environment.
 ```
 
 ## Description

content/docs/command-reference/deployment/run.md

@@ -6,13 +6,9 @@ declaration or create a new one on-the-fly.
 ## Synopsis
 
 ```usage
-usage: mlem deployment run [-m <text>] [-t <text>] [-p <path>] [-e]
-                           [--index] [-c <text>] [-h]
-                           path
-
-arguments:
-  path             Path to deployment meta (will be created if it does not
-                   exist)
+usage: mlem deployment run [-l <path>] [-m <path>] [--mp <path>]
+                           [--mr <commitish>] [-p <path>]
+                           [--rev <commitish>] [-h]
 ```
 
 ## Description
@@ -24,12 +20,12 @@ options (see below).
 
 ## Options
 
-- `-m <text>`, `--model <text>` - Path to model
-- `-t <text>`, `--env <text>` - Path to target environment
+- `-l <path>`, `--load <path>` - File to load deployment config from
+- `-m <path>`, `--model <path>` - Path to MLEM model
+- `--mp <path>`, `--model-project <path>` - Project with model
+- `--mr <commitish>`, `--model-rev <commitish>` - Revision of model
 - `-p <path>`, `--project <path>` - Path to MLEM project [default: (none)]
-- `-e`, `--external` - Save result not in .mlem, but directly in project
-- `--index` / `--no-index` - Whether to index output in .mlem directory
-- `-c <text>`, `--conf <text>` - Options in format `field.name=value`
+- `--rev <commitish>` - Repo revision to use [default: (none)]
 - `-h`, `--help` - Show this message and exit.
 
 ## Example: Create a new deployment from scratch
@@ -38,10 +34,10 @@ Here, we define an environment and then run a deployment on it, providing the
 deployment configuration on-the-fly
 
 ```cli
-$ mlem declare env heroku staging --conf api_key=...
+$ mlem declare env heroku staging --api_key=...
 ...
 
-$ mlem deployment run service_name --model model --env staging --conf name=my_service
+$ mlem deployment run service_name --model model --env staging --name=my_service
 ...
 ```
 
@@ -53,10 +49,10 @@ deployment with a simple concise command which uses the existing pre-configured
 deployment declaration
 
 ```cli
-$ mlem declare env heroku staging --conf api_key=...
+$ mlem declare env heroku staging --api_key=...
 ...
 
-$ mlem declare deployment heroku service_name --conf app_name=my_service --conf model=model --conf env=staging
+$ mlem declare deployment heroku service_name --app_name=my_service --model=model --env=staging
 ...
 
 $ mlem deploy run service_name

content/docs/command-reference/import.md

@@ -1,13 +1,13 @@
 # import
 
-Create a `.mlem` metafile for a model or data in any file or directory.
+Create a `.mlem` [MLEM Object](/doc/user-guide/basic-concepts) for a model or
+data in any file or directory.
 
 ## Synopsis
 
 ```usage
 usage: mlem import [-p <path>] [--rev <commitish>]
-                   [--tp <path>] [--copy] [--type <text>]
-                   [--index] [-e] [-h]
+                   [--tp <path>] [--copy] [--type <text>] [-h]
                    uri target
 
 arguments:
@@ -35,8 +35,6 @@ load those models/datasets into object for subsequent usage in MLEM context.
   or just link existing file [default: copy]
 - `--type <text>` - Specify how to read file Available types: ['pandas',
   'pickle', 'torch'] [default: (auto infer)]
-- `--index` / `--no-index` - Whether to index output in .mlem directory
-- `-e`, `--external` - Save result not in .mlem, but directly in project
 - `-h`, `--help` - Show this message and exit.
 
 ## Examples
@@ -58,6 +56,10 @@ $ mlem import data/model.pkl data/imported_model
 Create a MLEM model from remote `.pkl` (pickle) file
 
 ```cli
-$ mlem import .mlem/model/rf --project https://github.com/iterative/example-mlem-get-started --rev main data/imported_model --type pickle
-💾 Saving model to .mlem/model/data/imported_model.mlem
+$ mlem import models/rf \
+    --project https://github.com/iterative/example-mlem-get-started \
+    --rev main \
+    data/imported_model \
+    --type pickle
+💾 Saving model to data/imported_model.mlem
 ```

content/docs/command-reference/index.md

@@ -7,9 +7,9 @@ For a list of all commands, type `mlem -h`
 
 ## Typical MLEM workflow
 
-- Initialize a MLEM project in a Git Repo with
-  [mlem init](/doc/command-reference/init).
-- Save Models and Data with MLEM.
+First, save models with MLEM using [mlem.api.save](/doc/api-reference/save).
+Second, productionize them as you want:
+
 - Load and Apply models with [mlem apply](/doc/command-reference/apply).
 - Build models into Python packages or Docker images with
   [mlem build](/doc/command-reference/build).