Add roadmap and update readme

Signed-off-by: kerthcet <[email protected]>

Author: kerthcet

README.md

@@ -27,12 +27,20 @@ _Name Story: the inspiration of the name `Manta` is coming from Dota2, called [M
 
 ## Features Overview
 
-- **Model Preheat**: Models could be preloaded to clusters, to specified nodes to accelerate the model serving.
-- **Model Cache**: Models will be cached after downloading for faster model loading.
-- **Model Lifecycle Management**: Manage the model lifecycle automatically with different policies, like `Retain` or `Delete`.
+- **Model Hub Support**: Models could be downloaded directly from model hubs (Huggingface etc.) or object storages, no other efforts.
+- **Model Preheat**: Models could be preloaded to clusters, or specified nodes to accelerate the model serving.
+- **Model Cache**: Models will be cached as chunks after downloading for faster model loading.
+- **Model Lifecycle Management**: Model lifecycle is managed automatically with different strategies, like `Retain` or `Delete`.
 - **Plugin Framework**: _Filter_ and _Score_ plugins could be extended to pick up the best candidates.
 - **Memory Management(WIP)**: Manage the reserved memories for caching, together with LRU algorithm for GC.
 
+## You Should Know Before
+
+- Manta is not an all-in-one solution for model management, instead, it offers a lightweight solution to utilize the idle bandwidth and cost-effective disk, helping you save money.
+- It requires no additional components like databases or storage systems, simplifying setup and reducing effort.
+- All the models will be stored under the host path of `/mnt/models/`
+- After all, it's just a **cache system**.
+
 ## Quick Start
 
 ### Installation
@@ -87,6 +95,12 @@ spec:
 
 More details refer to the [APIs](https://github.com/InftyAI/Manta/blob/main/api/v1alpha1/torrent_types.go).
 
+## Roadmap
+
+- Preloading datasets from model hubs
+- RDMA support for faster model loading
+- More integrations with serving projects
+
 ## Community
 
 Join us for more discussions:

docs/installation.md

@@ -13,6 +13,22 @@ VERSION=v0.0.3
 kubectl apply --server-side -f https://github.com/inftyai/manta/releases/download/$VERSION/manifests.yaml
 ```
 
+After installation, you will see outputs like：
+
+- ` kubectl get pods -n manta-system`
+    ```
+    NAME                                        READY   STATUS    RESTARTS   AGE
+    manta-agent-jdnt5                           1/1     Running   0          77s
+    manta-agent-n55rq                           1/1     Running   0          77s
+    manta-controller-manager-567b565c54-pzvlc   2/2     Running   0          77s
+    ```
+- `kubectl get nodetrackers`
+    ```
+    NAME           AGE
+    kind-worker    35s
+    kind-worker2   29s
+    ```
+
 ### Uninstall
 
 ```cmd
@@ -30,6 +46,22 @@ cd manta
 IMG=<IMAGE_REGISTRY>/<IMAGE_NAME>:<GIT_TAG> make image-push deploy
 ```
 
+After installation, you will see outputs like：
+
+- ` kubectl get pods -n manta-system`
+    ```
+    NAME                                        READY   STATUS    RESTARTS   AGE
+    manta-agent-jdnt5                           1/1     Running   0          77s
+    manta-agent-n55rq                           1/1     Running   0          77s
+    manta-controller-manager-567b565c54-pzvlc   2/2     Running   0          77s
+    ```
+- `kubectl get nodetrackers`
+    ```
+    NAME           AGE
+    kind-worker    35s
+    kind-worker2   29s
+    ```
+
 ### Uninstall
 
 ```cmd

go.mod

@@ -3,6 +3,7 @@ module github.com/inftyai/manta
 go 1.22.0
 
 require (
+	github.com/go-logr/logr v1.4.2
 	github.com/google/go-cmp v0.6.0
 	github.com/onsi/ginkgo/v2 v2.19.0
 	github.com/onsi/gomega v1.34.1
@@ -25,7 +26,6 @@ require (
 	github.com/evanphx/json-patch/v5 v5.9.0 // indirect
 	github.com/fsnotify/fsnotify v1.7.0 // indirect
 	github.com/fxamacker/cbor/v2 v2.7.0 // indirect
-	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/zapr v1.3.0 // indirect
 	github.com/go-openapi/jsonpointer v0.21.0 // indirect
 	github.com/go-openapi/jsonreference v0.21.0 // indirect