Skip to content

Commit 04723c4

Browse files
docs(*): refine contents
1 parent 64650dd commit 04723c4

File tree

2 files changed

+35
-39
lines changed

2 files changed

+35
-39
lines changed

README.md

Lines changed: 33 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -4,73 +4,69 @@
44

55
## Low-Code, AI-Native Streaming Intelligence
66

7-
87
[<img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" >](http://winkjs.org/)
98

9+
WinkComposer is an **upcoming** Open Source, high-performance JavaScript framework built on Node.js for real-time streaming analytics. It transforms continuous data streams into actionable insights using a reactive processing graph that intelligently manages workloads.
1010

11-
WinkComposer is an **upcoming Open Source** low‑code, AI‑native streaming‑analytics framework on Node.js. It turns continuous data streams into actionable insights via a reactive processing graph, domain ontologies, and an LLM‑powered reasoning layer that delivers root‑cause analysis and recommendations.
11+
This graph prioritizes control and data messages, manages backpressure effectively, and uses adaptive yielding to stay responsive under varying loads. It ensures that both asynchronous and synchronous operations are executed efficiently without overwhelming the system.
1212

13-
## What is wink-composer?
13+
Each graph node is lightweight and modular, designed to execute streaming algorithms in real time. Nodes support both CPU-bound operations—such as filtering, transformation, and specialized algorithms for aggregation, statistical analysis, anomaly detection, and more—and I/O-bound tasks like database queries or LLM-based inference. This versatility makes WinkComposer suitable for domains such as IoT, telematics, smart infrastructure, finance, and healthcare.
1414

15-
WinkComposer is a high‑performance JavaScript framework for real‑time streaming analytics. It intelligently manages streaming work items, prioritising control and data messages while maintaining back‑pressure and adaptive yielding for maximum responsiveness.
15+
WinkComposer goes beyond basic analytics by integrating statistical methods and machine learning algorithms directly into its streaming engine. A built-in knowledge graph unifies business entities, patterns, and events. By persisting it in graph databases like Neo4j or ArangoDB, it forms a digital twin of your domain—enabling semantically rich queries and deeper contextual insights.
1616

17-
Each graph node is lightweight and modular, designed to efficiently execute streaming-analytics algorithms in real time. The framework supports both synchronous CPU‑bound operations and asynchronous I/O‑bound processes, making it versatile for IoT, smart infrastructure, telematics, finance, and more. Statistical methods and machine‑learning algorithms are integrated directly into the engine and enriched by a knowledge graph that unifies business objects, patterns, and events. By persisting in graph databases such as Neo4j or ArangoDB, the knowledge graph forms a digital twin of your domain, empowering richer queries and delivering deeper insights.
17+
At its core, WinkComposer includes an ontology-driven, LLM-powered reasoning layer that analyzes event streams to uncover patterns, identify root causes, and generate real-time, actionable recommendations. This empowers teams to make faster decisions, resolve issues efficiently, and onboard new members more effectively through embedded contextual knowledge.
1818

19-
WinkComposer leverages an ontology-driven, LLM-powered reasoning framework to analyze events, patterns, and data, uncover root causes, and deliver actionable recommendations. This supports near real-time insights, enabling faster, smarter decisions. Additionally, it helps support teams resolve issues quickly and accelerates onboarding with contextual learning for new team members.
20-
19+
## Key Features
2120

22-
### Our Focus
23-
1. **Ease of Use**: Focus on your application logic without worrying about underlying complexities.
21+
### Reactive Graph Execution
22+
- Adaptive Yield Threshold keeps the event loop responsive.
2423

25-
1. **Open Source/Weight LLMs**: Prioritizing smaller Open Source and efficient LLMs to empower developers.
24+
- Backpressure Management handles peak loads without memory overflow.
2625

27-
1. **Extensibility**: Modular, loosely coupled components built for contribution.
26+
- Priority Scheduling ensures control > data > async messages.
2827

29-
1. **Safety & Security**: Responsible AI and OpenSSF compliance.
28+
- Built-in Monitoring & Memory Tracking for observability.
3029

31-
## Key Features
30+
- Node-Level Error Isolation prevents local failures from crashing the graph.
3231

33-
### Reactive Graph Execution
34-
- **Adaptive Yield Threshold** keeps the event loop smooth.
32+
- Periodic Snapshots enable quick recovery from faults.
3533

36-
- **Back‑pressure Management** prevents overload during peak streams.
34+
### Low-Code Graph DSL
35+
- Define pipelines in a declarative manner.
3736

38-
- **Priority Scheduling** (control > data > async messages).
37+
- Drag-and-drop UI is already planned.
3938

40-
- **Monitoring Hooks & Memory Tracking** built in.
39+
### Plugin-Based Node Architecture
40+
- Simple plugin pattern for custom node development.
4141

42-
- **Node-Level Error Containment**: Node errors are captured and handled locally, ensuring the graph continues running smoothly.
42+
- Includes rich starter pack: statistical summaries, anomaly detectors, Count-Min Sketch, MQTT/Kafka sources, and Neo4j/Parquet sinks.
4343

44-
- **Periodic Graph Snapshots**: Save graph state periodically to aid fast recovery.
45-
44+
- Emphasis on numerical stability.
4645

47-
### Low‑Code Graph DSL
48-
- Declarative JSON/YAML definition of processing pipelines.
46+
### Ontology, Knowledge Graph & Digital Twin
47+
- Ontologies modeled in graph DBs like Neo4j or ArangoDB.
4948

50-
- Drag‑and‑drop UI planned.
49+
- Patterns, aggregates, and events as first-class graph elements.
50+
- Query the digital twin for root cause, impact, and what-if analysis.
51+
- LLM-assisted reasoning explains anomalies and suggests next steps.
5152

53+
## Our Focus
5254

53-
### Plugin based Node Architecture
54-
- Well-defined pattern for new plugin development
55+
1. Ease of Use – A declarative design simplifies development and enables rapid iteration.
5556

56-
- Rich starter pack such as comprehensive streaming statistics, threshold/anomaly detectors, count-min sktech and MQTT/Kafka source connectors to Neo4j/Parquet sinks.
57+
1. Extensibility – Modular, loosely coupled components for easy customization and contributions.
5758

58-
- Numerical stability
59-
59+
1. Open Source & Lightweight LLMs – Prioritizing efficient, accessible models for developers.
6060

61-
### Ontology, Knowledge Graph & Digital Twin
62-
- Domain‑specific ontologies captured in a graph DB (Neo4j, ArangoDB).
61+
1. Safety & Security – Aligned with responsible AI principles and OpenSSF best practices.
6362

64-
- Patterns, aggregates, and events stored as first‑class nodes/edges.
6563

66-
- Query the digital twin for impact analysis, what‑if simulations, and contextual recommendations.
64+
## Contributions Welcome
6765

68-
- **LLM‑assisted reasoning** layer explains anomalies and surfaces root causes.
66+
WinkComposer is in active early development — we invite you to [join the conversation on GitHub Discussions](https://github.com/winkjs/wink-composer/discussions) or reach out via email at [email protected].
6967

70-
## Contributions are welcome
71-
We are in early development — join the conversation in [GitHub Discussions](https://github.com/winkjs/wink-composer/discussions) or email us at [email protected].
68+
Let’s shape the future of real-time streaming analytics together!
7269

73-
Together, let’s shape the future of real‑time streaming analytics!
7470

7571
## About winkJS
7672
[WinkJS](https://github.com/winkjs) is a family of open source packages for **Natural Language Processing**, **Machine Learning**, and **Statistical Analysis** in Javascript. The code is **thoroughly documented** for easy human comprehension and has a **test coverage of ~100%** for reliability to build production grade solutions.

docs/_coverpage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
![logo](_media/wink-logo.png)
33

4-
# wink-composer <small>0.1</small>
4+
# wink-composer <small></small>
55

6-
> Streaming Data. Orchestrated. Explained. ♫
6+
> Low-Code, AI-Native Streaming Intelligence
77
88
- 📊 Real-time Streaming Analytics
99
- 🕸️ Knowledge Graph Digital Twin

0 commit comments

Comments
 (0)