Skip to content

Commit fb018ec

Browse files
committed
add md
1 parent 1822873 commit fb018ec

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<p align="left"><img src="_static/images/MLRun-logo.png" alt="MLRun logo" width="150"/></p>
2+
3+
4+
# The Open Source MLOps Orchestration Framework
5+
6+
MLRun **simplifies & accelerates** the production pipeline design using a modular strategy, where the different parts contribute to a continuous, automated, and far simpler path from research and development to scalable production pipelines, without refactoring code, adding glue logic, or spending significant efforts on data and ML engineering.
7+
8+
MLRun uses **Serverless Function** technology: write the code once, using your preferred development environment and simple “local” semantics, and then run it as-is on different platforms and at scale. MLRun automates the data processing and movement, build process, execution, scaling, versioning, parameterization, outputs tracking, CI/CD integration, deployment to production, monitoring, and more.
9+
10+
11+
## Configure Your Environment
12+
13+
MLRun backend service can run locally or over Kubernetes (preferred), see the instructions for installing it [**locally** using Docker](https://docs.mlrun.org/en/latest/install/local-docker.html) or [over **Kubernetes** Cluster](https://docs.mlrun.org/en/latest/install/kubernetes.html). Alternatively, you can use [Iguazio's **managed** MLRun service](https://www.iguazio.com/docs/latest-release/).
14+
15+
This Jupyter Notebook server is designed to work with the different options, it works out of the box with the **local** deployment mode.<br>
16+
In order to work with remote MLRun service (Kubernetes or managed) you need to edit and save the [**mlrun.env**](./mlrun.env) file in the following way:
17+
18+
```sh
19+
# set remote MLRun service address, username and access-key
20+
MLRUN_DBPATH=https://<service-address>
21+
V3IO_USERNAME=<user>
22+
V3IO_ACCESS_KEY=<access-key>
23+
```
24+
25+
**Once You are done, save the file using the menu or `ctrl + s`, you may need to restart existing Notebooks for the changes to take effect.**
26+
27+
## Tutorials and Examples
28+
29+
Open the [**quick-start.ipynb**](quick-start/quick-start.ipynb) Notebook and follow the instructions in it.
30+
31+
See the more detailed tutorial under the [**tutorial folder**](./tutorial/index.md).
32+
33+
You can find different end to end demos in under the [**demos folder**](./demos/README.md).
34+
35+
Or go through interactive MLRun [**Katacoda Scenarios**](https://www.katacoda.com/mlrun) which teach how to install and use MLRun.
36+
37+
38+
39+
```python
40+
41+
```

0 commit comments

Comments
 (0)