Skip to content

Commit b415386

Browse files
committed
fix(readme): removed snippets for now
1 parent 66ae094 commit b415386

1 file changed

Lines changed: 2 additions & 19 deletions

File tree

README.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -90,15 +90,7 @@ Create, render, and publish data visualizations from notebooks or the in-browser
9090
| networkx | SVG | Network/graph visualizations |
9191
| geopandas | SVG | Geospatial maps |
9292

93-
```python
94-
import openmodelstudio as oms
95-
96-
viz = oms.create_visualization("loss-curve", backend="plotly")
97-
output = oms.render(fig, viz_id=viz["id"]) # auto-detects backend
98-
oms.publish_visualization(viz["id"]) # available for dashboards
99-
```
100-
101-
Combine visualizations into **drag-and-drop dashboards** with resizable panels, lock/unlock layout, and persistent configuration. Each visualization also has a full **in-browser editor** (`/visualizations/{id}`) with Monaco, live preview for JSON backends, template insertion, and data/config tabs.
93+
Combine visualizations into **drag-and-drop dashboards** with resizable panels, lock/unlock layout, and persistent configuration. Each visualization also has a full **in-browser editor** with Monaco, live preview for JSON backends, template insertion, and data/config tabs. See the [Visualizations Guide](docs/VISUALIZATIONS.md) for SDK usage.
10294

10395
<p align="center">
10496
<img src="docs/screenshots/oms-screenshot3.png" alt="OpenModelStudio Visualization Framework" width="100%" />
@@ -115,16 +107,7 @@ openmodelstudio install iris-svm # Install a model
115107
openmodelstudio list # List installed models
116108
```
117109

118-
**From a notebook or script:**
119-
```python
120-
import openmodelstudio as oms
121-
122-
iris = oms.use_model("iris-svm") # Load from registry
123-
handle = oms.register_model("my-iris", model=iris) # Register in project
124-
job = oms.start_training(handle.model_id, wait=True) # Train it
125-
```
126-
127-
`use_model()` resolves via the platform API, so it works inside workspace containers (K8s pods) without filesystem access. If the model isn't installed yet, it auto-installs from the registry. The web UI registry page shows **Installed** / **Not Installed** badges that stay in sync with CLI operations.
110+
From notebooks or scripts, use `oms.use_model("iris-svm")` to load an installed model, then register and train it with the SDK. Works inside workspace containers via the platform API — no filesystem access needed. Install status syncs bidirectionally between CLI and UI. See the [Registry Guide](docs/CLI-REGISTRY.md) for full SDK usage.
128111

129112
---
130113

0 commit comments

Comments
 (0)