From 0654e672028291089be781154925c332e708e089 Mon Sep 17 00:00:00 2001 From: Mynt Labs Date: Thu, 19 Jun 2025 15:12:25 +1000 Subject: [PATCH] Move quickstart up in readme --- README.md | 25 +++--- .../docker-compose.v0.1.24.yml | 82 ++++++++++++++++++ .../flintml-v0.1.24/worker.v0.1.24.yaml | 3 + quick/quicker/flintml.tar.gz | Bin 0 -> 781 bytes 4 files changed, 96 insertions(+), 14 deletions(-) create mode 100644 quick/quicker/flintml-v0.1.24/docker-compose.v0.1.24.yml create mode 100644 quick/quicker/flintml-v0.1.24/worker.v0.1.24.yaml create mode 100644 quick/quicker/flintml.tar.gz diff --git a/README.md b/README.md index f9a76fc..af315a3 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,16 @@ FlintML Logo Text
+## 🚀 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.) + ## FlintML Logo 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. @@ -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 diff --git a/quick/quicker/flintml-v0.1.24/docker-compose.v0.1.24.yml b/quick/quicker/flintml-v0.1.24/docker-compose.v0.1.24.yml new file mode 100644 index 0000000..17d0c36 --- /dev/null +++ b/quick/quicker/flintml-v0.1.24/docker-compose.v0.1.24.yml @@ -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: \ No newline at end of file diff --git a/quick/quicker/flintml-v0.1.24/worker.v0.1.24.yaml b/quick/quicker/flintml-v0.1.24/worker.v0.1.24.yaml new file mode 100644 index 0000000..019e0e9 --- /dev/null +++ b/quick/quicker/flintml-v0.1.24/worker.v0.1.24.yaml @@ -0,0 +1,3 @@ +driver: + type: local + image: flintml/worker-base:0.1.24 diff --git a/quick/quicker/flintml.tar.gz b/quick/quicker/flintml.tar.gz new file mode 100644 index 0000000000000000000000000000000000000000..2dddbd2a5f47bab4f8b5b7295e91d8ff792f057b GIT binary patch literal 781 zcmV+o1M>VIiwFP!000001MQbvZ`v>vfO+OuSZ%e3NzMflQbp}US7?R0K^0i{7_&}y2$7c0)OeQrKEc?^R%jY2rq6kTZ;YV8PU9LqGts9UC< zJ?pJjHs;iHQ)?KOt{G;drs)mKGHSp)hB9SFEJYN68Xd(krkmw_;{Dq8{vYMB6#to- z&?8Yo7*_IWWfFydeufBe%P=;@ziDWVQv9uE)2adOaAt1iKac+_WGSKO2}6%!pV{D3 z;kga~j>iEdafIX4=8pgjhJEMiw&Q*ubQ~L;y%nAz@}nT076k9F27@1cr@bn?n1cyo z?1fN&TCX!q$AO2LUFYjh0fZ2Ixw^jV^xA;${m{Mc48){(n`=4K=;Fc#pUZj!5JW-( z>f^B*kHV0z9V4ppo069ah4EpNefTxOG!SV6MO^o@aDDNLjXq9r z>@%0db2AIsAn-`+2Wh}1K%P|YGe%+hJgN55^1M9s6enbpWv8dJ+`Mu6yK}g}3{M zK4aJY*R@vZ{x{85L*D=QpwR1IR`&OW|A$NED4z(4L?V$$Boc{4B9TZW5{X12ksO%c L