Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@
<img width="100%" src="docs/_assets/screenshot.png" alt="FlintML Logo Text" /><br/>
</div>

## 🚀 Quickstart

```bash
curl -sL https://raw.githubusercontent.com/flintml/flint/main/flintml-quickstart.sh | bash
```

FlintML will become available at `localhost:8701`. The first time you execute code may take a couple of minutes while FlintML downloads the relevant worker image.

**Note:** ensure Docker is installed and you are on a Linux (or WSL) machine (ARM currently not supported.)

## <img src="docs/_assets/logo.png" alt="FlintML Logo" width="17"/> Why FlintML?

FlintML enables teams to deliver end-to-end ML quickly and with minimal infrastructure overhead. With FlintML, all key components of the MLOps process are centralised, providing an integrated and developer-centric experience.
Expand All @@ -37,20 +47,7 @@ FlintML enables teams to deliver end-to-end ML quickly and with minimal infrastr

## 🔎 Demo

To get a sense of what you can do with FlintML, check out the [Instacart Kaggle example](examples/instacart.ipynb).

## 🚀 Quickstart

**Note:** ensure Docker is installed and you are on a Linux (or WSL) machine (ARM currently not supported.)

```bash
curl -sL https://raw.githubusercontent.com/flintml/flint/main/flintml-quickstart.sh | bash
```

FlintML will become available at `localhost:8701`. The first time you execute code may take a couple of minutes while FlintML downloads the relevant worker image.

### [Concepts](docs/concepts.md)
### [Reference](docs/reference.md)
To get a sense of what you can do with FlintML, check out the [Instacart Kaggle example](examples/instacart.ipynb). You can also read about FlintML [concepts](docs/concepts.md) and check out the [reference](docs/reference.md) to learn more about the platform's capabilities

## ⚙️ Customising Your Deployment

Expand Down
82 changes: 82 additions & 0 deletions quick/quicker/flintml-v0.1.24/docker-compose.v0.1.24.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
x-storage-creds: &storage-creds
environment:
STORAGE_USER: ${STORAGE_USER:-admin}
STORAGE_PASSWORD: ${STORAGE_PASSWORD:-password}

services:

# --- BACKEND SERVICES ---

storage:
<<: *storage-creds
image: flintml/storage:0.1.24
volumes:
- storage_data:/usr/src/app/localData
- storage_meta:/usr/src/app/localMetadata
restart: always

compute-manager:
<<: *storage-creds
image: flintml/compute-manager:0.1.24
volumes:
- ${DRIVER_CONFIG}:/app/worker/worker.yaml
- ${DOCKER_SOCKET:-/dev/null}:/var/run/docker.sock
restart: always

experiment-server:
<<: *storage-creds
image: flintml/experiment-server:0.1.24
depends_on:
storage:
condition: service_healthy
volumes:
- experiment_data:/repo
restart: always

### --- FRONTEND SERVICES ---

catalog-explorer:
<<: *storage-creds
image: flintml/catalog-explorer:0.1.24
depends_on:
storage:
condition: service_healthy
restart: always

experiment-tracker:
image: flintml/experiment-tracker:0.1.24
depends_on:
experiment-server:
condition: service_healthy
volumes:
- experiment_data:/repo
restart: always

workspace:
<<: *storage-creds
image: flintml/workspace:0.1.24
depends_on:
- catalog-explorer
- experiment-tracker
volumes:
- workspace_data:/srv/workspace
restart: always

reverse-proxy:
image: flintml/reverse-proxy:0.1.24
depends_on:
- storage
- workspace
- compute-manager
- catalog-explorer
- experiment-server
- experiment-tracker
ports:
- "${FLINT_PORT:-8701}:80"
restart: always

volumes:
storage_data:
storage_meta:
experiment_data:
workspace_data:
3 changes: 3 additions & 0 deletions quick/quicker/flintml-v0.1.24/worker.v0.1.24.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
driver:
type: local
image: flintml/worker-base:0.1.24
Binary file added quick/quicker/flintml.tar.gz
Binary file not shown.