Content for /docs

content/docs/api-reference/apply.md

@@ -0,0 +1,19 @@
+# apply
+Apply provided model against provided data
+
+    Args:
+        model (ModelMeta): MLEM model.
+        data (Any): Input to the model.
+        method (str, optional): Which model method to use.
+            If None, use the only method model has.
+            If more than one is available, will fail.
+        output (str, optional): If value is provided,
+            assume it's path and save output there.
+        link (bool): Whether to create a link to saved output in MLEM root folder.
+        external (bool): Whether to save result outside mlem dir
+
+    Returns:
+        If `output=None`, returns results for given data.
+            Otherwise returns None.
+
+

content/docs/api-reference/clone.md

@@ -0,0 +1,21 @@
+# clone
+Clones MLEM object from `path` to `out`
+        and returns Python representation for the created object
+
+    Args:
+        path (str): Path to the object. Could be local path or path inside a git repo.
+        target (str): Path to save the copy of initial object to.
+        repo (Optional[str], optional): URL to repo if object is located there.
+        rev (Optional[str], optional): revision, could be git commit SHA, branch name or tag.
+        fs (Optional[AbstractFileSystem], optional): filesystem to load object from
+        target_repo (Optional[str], optional): path to repo to save cloned object to
+        target_fs (Optional[AbstractFileSystem], optional): target filesystem
+        follow_links (bool, optional): If object we read is a MLEM link, whether to load
+            the actual object link points to. Defaults to True.
+        load_value (bool, optional): Load actual python object incorporated in MlemMeta object. Defaults to False.
+        link: whether to create link in target repo
+        external: wheter to put object inside mlem dir in target repo
+
+    Returns:
+        MlemMeta: Copy of initial object saved to `out`
+

content/docs/api-reference/deploy.md

@@ -0,0 +1 @@
+# deploy

content/docs/api-reference/import_object.md

@@ -0,0 +1,4 @@
+# import_object
+Try to load an object as MLEM model (or dataset) and return it,
+    optionally saving to the specified target location
+

content/docs/api-reference/index.md

@@ -0,0 +1 @@
+do we want each command in separate file?

content/docs/api-reference/init.md

@@ -0,0 +1,2 @@
+# init
+Creates .mlem directory in `path`

content/docs/api-reference/link.md

@@ -0,0 +1,18 @@
+# link
+Creates MlemLink for an `source` object and dumps it if `target` is provided
+
+    Args:
+        source (Union[str, MlemMeta]): The object to create link from.
+        source_repo (str, optional): Path to mlem repo where to load obj from
+        rev (str, optional): Revision if object is stored in git repo.
+        target (str, optional): Where to store the link object.
+        target_repo (str, optional): If provided,
+            treat `target` as link name and dump link in MLEM DIR
+        follow_links (bool): Whether to make link to the underlying object
+            if `source` is itself a link. Defaults to True.
+        external (bool): Whether to save link outside mlem dir
+        absolute (bool): Whether to make link absolute or relative to mlem repo
+
+    Returns:
+        MlemLink: Link object to the `source`.
+

content/docs/api-reference/load.md

@@ -0,0 +1,13 @@
+# load
+Load python object saved by MLEM
+
+    Args:
+        path (str): Path to the object. Could be local path or path inside a git repo.
+        repo (Optional[str], optional): URL to repo if object is located there.
+        rev (Optional[str], optional): revision, could be git commit SHA, branch name or tag.
+        follow_links (bool, optional): If object we read is a MLEM link, whether to load the
+            actual object link points to. Defaults to True.
+
+    Returns:
+        Any: Python object saved by MLEM
+

content/docs/api-reference/load_meta.md

@@ -0,0 +1,15 @@
+# load_meta
+Load MlemMeta object
+
+    Args:
+        path (str): Path to the object. Could be local path or path inside a git repo.
+        repo (Optional[str], optional): URL to repo if object is located there.
+        rev (Optional[str], optional): revision, could be git commit SHA, branch name or tag.
+        follow_links (bool, optional): If object we read is a MLEM link, whether to load the
+            actual object link points to. Defaults to True.
+        load_value (bool, optional): Load actual python object incorporated in MlemMeta object. Defaults to False.
+        fs: filesystem to load from. If not provided, will be inferred from path
+        force_type: type of meta to be loaded. Defaults to MlemMeta (any mlem meta)
+    Returns:
+        MlemMeta: Saved MlemMeta object
+

content/docs/api-reference/ls.md

@@ -0,0 +1 @@
+# ls

content/docs/api-reference/pack.md

@@ -0,0 +1,8 @@
+# pack
+Pack model in docker-build-ready folder or directly build a docker image.
+
+    Args:
+        packager (Union[str, Packager]): Packager to use.
+            Out-of-the-box supported string values are "docker_dir" and "docker".
+        model (Union[str, ModelMeta]): The model to pack.
+

content/docs/api-reference/save.md

@@ -0,0 +1,23 @@
+# save
+Saves given object to a given path
+
+    Args:
+        obj: Object to dump
+        path: If not located on LocalFileSystem, then should be uri
+            or `fs` argument should be provided
+        repo: path to mlem repo (optional)
+        dvc: Store the object's artifacts with dvc
+        tmp_sample_data: If the object is a model or function, you can
+            provide input data sample, so MLEM will include it's schema
+            in the model's metadata
+        fs: FileSystem for the `path` argument
+        link: Whether to create a link in .mlem folder found for `path`
+        external: if obj is saved to repo, whether to put it outside of .mlem dir
+        description: description for object
+        params: arbitrary params for object
+        tags: tags for object
+        update: whether to keep old description/tags/params if new values were not provided
+
+    Returns:
+        None
+

content/docs/api-reference/serve.md

@@ -0,0 +1,7 @@
+# serve
+Serve model via HTTP/HTTPS.
+
+    Args:
+        model (ModelMeta): The model to serve.
+        server (Union[Server, str]): Out-of-the-box supported one is "fastapi".
+

content/docs/cli-reference/apply.md

@@ -0,0 +1,39 @@
+# apply
+Usage:  [options] model data
+
+Apply a model to a dataset. Resulting dataset will be saved as MLEM object
+	to `output` if it is provided, otherwise will be printed
+
+Arguments:
+
+	MODEL  Path to model object  [required]
+	DATA   Path to dataset object  [required]
+
+Options:
+
+	-r, --repo TEXT           Path to MLEM repo  [default: (none)]
+	--rev TEXT                Repo revision to use  [default: (none)]
+	-o, --output TEXT         Where to store the outputs.
+	-m, --method TEXT         Which model method is to apply  [default: predict]
+	--data-repo, --dr TEXT    Repo with dataset
+	--data-rev TEXT           Revision of dataset
+	-i, --import              Try to import data on-the-fly
+	--import-type, --it TEXT  Specify how to read data file for import
+	--link / --no-link        Whether to create link for output in .mlem
+                            directory
+	-e, --external            Save result not in .mlem, but directly in repo
+	--json                    Output as json
+	--help                    Show this message and exit.
+
+Examples:
+
+    Apply local mlem model to local mlem dataset
+    $ mlem apply mymodel mydatset --method predict --output myprediction
+
+    Apply local mlem model to local data file
+    $ mlem apply mymodel data.csv --method predict --import --import-type pandas[csv] --output myprediction
+
+    Apply a version of remote model to a version of remote dataset
+    $ mlem apply models/logreg --repo https://github.com/iterative/example-mlem --rev main
+                 data/test_x --data-repo https://github.com/iterative/example-mlem --data-rev main
+                 --method predict --output myprediction

content/docs/cli-reference/clone.md

@@ -0,0 +1,27 @@
+# clone
+Usage:  [options] uri target
+
+Download MLEM object from `uri` and save it to `target`
+
+Arguments:
+
+	URI     URI to object you want to clone  [required]
+	TARGET  Path to store the downloaded object.  [required]
+
+Options:
+
+	-r, --repo TEXT           Path to MLEM repo  [default: (none)]
+	--rev TEXT                Repo revision to use  [default: (none)]
+	--target-repo, --tr TEXT  Repo to save target to  [default: (none)]
+	-e, --external            Save result not in .mlem, but directly in repo
+	--link / --no-link        Whether to create link for output in .mlem
+                            directory
+	--help                    Show this message and exit.
+
+Examples:
+
+    Copy remote model to local directory
+    $ mlem clone models/logreg --repo https://github.com/iterative/example-mlem --rev main mymodel
+
+    Copy remote model to remote MLEM repo
+    $ mlem clone models/logreg --repo https://github.com/iterative/example-mlem --rev main mymodel --tr s3://mybucket/mymodel

content/docs/cli-reference/create.md

@@ -0,0 +1,24 @@
+# create
+Usage:  [options] object_type [subtype] path
+
+Creates new mlem object metafile from conf args and config files
+
+Arguments:
+
+    OBJECT_TYPE  Type of metafile to create  [required]
+    [SUBTYPE]    Subtype of MLEM object  [default: ]
+    PATH         Where to save object  [required]
+
+Options:
+
+    -c, --conf TEXT     Values for object fields in format
+                      `field.nested.name=value`
+    -r, --repo TEXT     Path to MLEM repo  [default: (none)]
+    -e, --external      Save result not in .mlem, but directly in repo
+    --link / --no-link  Whether to create link for output in .mlem directory
+    --help              Show this message and exit.
+
+Examples:
+
+    Create heroku deployment
+    $ mlem create env heroku production -c api_key=<...>

content/docs/cli-reference/import.md

@@ -0,0 +1,34 @@
+# import
+Usage:  [options] uri target
+
+Create MLEM model or dataset metadata from file/dir
+
+Arguments:
+
+	URI     File to import  [required]
+	TARGET  Path whare to save MLEM object  [required]
+
+Options:
+
+	-r, --repo TEXT           Path to MLEM repo  [default: (none)]
+	--rev TEXT                Repo revision to use  [default: (none)]
+	--target-repo, --tr TEXT  Repo to save target to  [default: (none)]
+	--copy / --no-copy        Whether to create a copy of file in target
+                            location or just link existing file  [default:
+                            copy]
+	--type TEXT               Specify how to read file  [default: (auto infer)]
+	--link / --no-link        Whether to create link for output in .mlem
+                            directory
+	-e, --external            Save result not in .mlem, but directly in repo
+	--help                    Show this message and exit.
+
+Examples:
+
+    Create MLEM dataset from local csv
+    $ mlem import data/data.csv data/imported_data --type pandas[csv]
+
+    Create MLEM model from local pickle file
+    $ mlem import data/model.pkl data/imported_model
+
+    Create MLEM model from remote pickle file
+    $ mlem import models/logreg --repo https://github.com/iterative/example-mlem --rev no-dvc data/imported_model --type pickle

content/docs/cli-reference/init.md

@@ -0,0 +1,18 @@
+# init
+Usage:  [options] [path]
+
+Initialize MLEM repo
+
+Arguments:
+
+    [PATH]  Where to init repo
+
+Options:
+
+	--help  Show this message and exit.
+
+Examples:
+
+    $ mlem init
+    $ mlem init some/local/path
+    $ mlem init s3://bucket/path/in/cloud

content/docs/cli-reference/link.md

@@ -0,0 +1,33 @@
+# link
+Usage:  [options] source target
+
+Create link for MLEM object
+
+Arguments:
+
+	SOURCE  URI to object you are crating link to  [required]
+	TARGET  Path to save link object  [required]
+
+Options:
+
+	--source-repo, --sr TEXT        Repo for source object
+	--rev TEXT                      Repo revision to use  [default: (none)]
+	--target-repo, --tr TEXT        Repo to save target to  [default: (none)]
+	-e, --external                  Save result not in .mlem, but directly in
+                                  repo
+	--follow-links, --f / --no-follow-links, --nf
+                                  If True, first follow links while reading
+                                  {source} before creating this link.
+                                  [default: follow-links]
+	--absolute, --abs / --relative, --rel
+                                  Which path to linked object to specify:
+                                  absolute or relative.  [default: relative]
+	--help                          Show this message and exit.
+
+Examples:
+
+    Add alias to local object
+    $ mlem link my_model latest
+
+    Add remote object to your repo without copy
+    $ mlem link models/logreg --source-repo https://github.com/iteartive/example-mlem remote_model

content/docs/cli-reference/list.md

@@ -0,0 +1,22 @@
+# list
+Usage:  [options] [repo]
+
+List MLEM objects of in repo
+
+Arguments:
+
+  [REPO]  Repo to list from  [default: (current directory)]
+
+Options:
+
+	-t, --type [all|link|model|dataset|env|deployment|packager]
+                                  Type of objects to list  [default: all]
+	--rev TEXT                      Repo revision to use  [default: (none)]
+    +l, --links / -l, --no-links    Include links  [default: l]
+	--json                          Output as json
+	--help                          Show this message and exit.
+
+Examples:
+
+    $ mlem list https://github.com/iterative/example-mlem
+    $ mlem list -t models

content/docs/cli-reference/pack.md

@@ -0,0 +1,28 @@
+# pack
+Usage:  [options] model [subtype]
+
+Pack model
+
+Arguments:
+
+	MODEL      Path to model  [required]
+	[SUBTYPE]  Type of packing. Choices: ['docker', 'docker_dir']
+
+Options:
+
+	-r, --repo TEXT       Path to MLEM repo  [default: (none)]
+	--rev TEXT            Repo revision to use  [default: (none)]
+	-l, --load TEXT       File to load packing config from
+	-c, --conf TEXT       Options for packing in format `field.name=value`
+	-f, --file_conf TEXT  File with options for packing in format
+                        `field.name=path_to_config`
+	--help                Show this message and exit.
+
+Examples:
+
+    Build docker image from model
+    $ mlem pack mymodel docker -c server.type=fastapi -c image.name=myimage
+
+    Create pack docker_dir declaration and build it
+    $ mlem create packager docker_dir -c server=fastapi -c target=build pack_dock
+    $ mlem pack mymodel --load pack_dock