Skip to content

Commit 95dec52

Browse files
committed
Update plugins.py.j2 and readme.md for clarity not creating a release yet as I need to document plugins and refine them, I shouldnt really be developing in main
1 parent f955977 commit 95dec52

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

poly_lithic/templates/plugin/plugins.py.j2

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ class CustomTransformer(BaseTransformer):
266266

267267
# Example configuration
268268

269-
self.updated = False
269+
self.updated = False # this is mandatory, it will be made into a mandatory attribute in future versions
270270
self.scale = config.get('scale', 1.0)
271271
self.offset = config.get('offset', 0.0)
272272
self.input_vars = config.get('input_vars', [])

readme.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,18 @@ pip install -r reqirements.txt
5353
pip install -e .
5454
```
5555

56+
Alternatively with uv:
57+
58+
```bash
59+
uv pip install poly-lithic
60+
```
61+
62+
for development with uv:
63+
```bash
64+
uv pip install -r requirements.txt
65+
uv pip install -e .
66+
```
67+
5668
with docker:
5769

5870
```bash
@@ -62,11 +74,11 @@ docker compose -f ./docker/docker_compose.yml up
6274
## Usage
6375

6476
```python
65-
model_manager --publish -c ./tests/pv_mapping_mlflow.yaml -e ./tests/env.json
77+
model_manager run --publish -c ./tests/pv_mapping_mlflow.yaml -e ./tests/env.json
6678
```
6779
or
6880
```python
69-
pl --publish -c ./tests/pv_mapping_mlflow.yaml -e ./tests/env.json
81+
pl run --publish -c ./tests/pv_mapping_mlflow.yaml -e ./tests/env.json
7082
```
7183
The env file is a json file that contains the environment variables that are used in the deployment. In this example we are pulling the [torch](./examples/torch_and_generic.ipynb) model and wrapping it with simple transformers and a simple p4p server.
7284

@@ -504,10 +516,11 @@ See the [MLFlow example notebook](./examples/base/simple_model_mlflow.ipynb) for
504516

505517
| Feature / Task | Timeline | Priority | Status |
506518
|-----------------------------------------------|--------------|----------|---------------|
507-
| 🖌️ 🎨 **Make logo** | 1–3 Months | 🥇 | 🚧 In Progress |
519+
| 🖌️ 🎨 **Make logo** | 1–3 Months | 🥇 | Compelte! |
520+
| 🔌 🧩 **Plugin System for Modules** | 1–3 Months | 🥇 | Complete! |
508521
| 🧠 🔧 **Lume-Model Integration** | 1–3 Months | 🥇 | 🚧 In Progress |
509-
| ⚡ 🔄 **Event driven mode** | 1-3 Months | 🥈 | ⏳ Planned |
510-
| 📦 🤖 **MLflow 3.x Support** | 1–3 Months | 🥇 | ⏳ Planned |
522+
| ⚡ 🔄 **Event driven mode** | 1-3 Months | 🥈 | 🚧 In Progress |
523+
| 📦 🤖 **MLflow 3.x Support** | 6–12 Months | 🥇 | ⏳ Planned |
511524
| 🌐 🚀 **Move to `gh-pages`** | 1–3 Months | 🥈 | 🚧 In Progress |
512525
| 🔗 🧪 **p4p4isis Interface** | 6–12 Months | 🥉 | ⏳ Planned |
513526
| 📊 🧭 **Time Series Aggregation** | 3–6 Months | 🥉 | ⏳ Planned |

0 commit comments

Comments
 (0)