Skip to content

Commit 72f2350

Browse files
committed
prepare demo and documents
1 parent 8d318c7 commit 72f2350

29 files changed

Lines changed: 104 additions & 53 deletions

README.md

Lines changed: 40 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,34 @@ A complete reasoning session typically answers the following questions:
4646

4747
---
4848

49+
## 🫧 Online Demo
50+
51+
If you are a:
52+
- Strategy Consultant
53+
- C-level Executive
54+
- Industry Analyst
55+
- Product Manager
56+
- Other non-technical users
57+
58+
Want to quickly experience Omen without local installation? Please visit our online demo deployed on Streamlit Cloud to quickly see the effect.
59+
60+
You can explore the strategic reasoning flow directly online:
61+
62+
[👉 Explore Omen on Streamlit Cloud](https://omen-demo.streamlit.app/)
63+
64+
---
65+
4966
## 🚀 Quick Start
5067

68+
If you are:
69+
70+
- Data Scientist
71+
- AI Researcher
72+
- Strategy Analyst
73+
- Other technical users
74+
75+
Want to run Omen in your local environment? Please follow the installation and running guide below.
76+
5177
### 🏗️ Installation
5278

5379
Environment requirements: Python 3.12+ with `pip` package manager.
@@ -59,19 +85,21 @@ pip install --upgrade pip setuptools wheel
5985
pip install -e .
6086
```
6187

62-
### 🌰 View Example
88+
### 🌰 Run Demo
6389

64-
If you want to quickly see Omen in action, a visualized sample case and its results are available in the `sample` directory. Run:
90+
If you want to quickly see Omen in action, a visualized sample case and its results are available in the `demo` directory. Run:
6591

6692
```bash
67-
streamlit run sample/app/scenario_planning.py
93+
streamlit run demo/app/scenario_planning.py
6894
```
6995

7096
Then open `http://localhost:8501` in your browser to explore the full strategic reasoning flow.
7197

7298
### 🎵 Run Built-in Case
7399

74-
If you want to run a complete end-to-end workflow, we have prepared a built-in case simulating SAP's acquisition of Reltio in March 2026. The case document is `cases/sap_reltio_acquisition.md`, and it can be run end-to-end with the following commands:
100+
If you want to run a complete **Analyze - Simulate - Explain** workflow, we have prepared a built-in case simulating SAP's acquisition of Reltio in March 2026.
101+
102+
The case document is `cases/situations/sap_reltio_acquisition.md`, and it can be run end-to-end with the following commands:
75103

76104
#### Step 1. Analyze
77105

@@ -153,17 +181,17 @@ Omen is built for the following roles:
153181

154182
### Strategic Actor Analyze
155183

156-
* [👤 Elon Musk](cases/actors/elon-musk.md)
157-
* [👤 Jeff Bezos](cases/actors/jeff-bezos.md)
158-
* [👤 Steve Jobs](cases/actors/steve-jobs.md)
159-
* [👤 Jack Ma](cases/actors/jack-ma.md)
160-
* [👤 Chen Jiaxing (me)](cases/actors/chen-jiaxing.md)
184+
* 👤 [Elon Musk](cases/actors/elon-musk.md)
185+
* 👤 [Jeff Bezos](cases/actors/jeff-bezos.md)
186+
* 👤 [Steve Jobs](cases/actors/steve-jobs.md)
187+
* 👤 [Jack Ma](cases/actors/jack-ma.md)
188+
* 👤 [Chen Jiaxing (me)](cases/actors/chen-jiaxing.md)
161189

162190
### Strategic Reasoning Cases
163191

164-
* [🧩 Acquisition: SAP vs Reltio](cases/situations/sap_reltio_acquisition.md)
165-
* [🗺️ Ontology Games: Database vs AI Memory](cases/ontology.md)
166-
* [⚔️ Vector Database vs AI Memory](cases/vector-memory.md)
192+
* 🧩 [Acquisition: SAP vs Reltio](cases/situations/sap_reltio_acquisition.md)
193+
* 🗺️ [Ontology Games: Database vs AI Memory](cases/ontology.md)
194+
* ⚔️ [Vector Database vs AI Memory](cases/vector-memory.md)
167195

168196
More scenarios are under development (contributions welcome):
169197
* `Agent Infrastructure` vs `Workflow Platforms`

README.zh.md

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,34 @@ Omen **不预测**单一未来,它是**为复杂性而生**的推演引擎。
4747

4848
---
4949

50-
## 🚀 快速开始
50+
## 🫧 在线演示
51+
52+
如果你是:
53+
54+
- 战略顾问
55+
- C级决策者
56+
- 行业分析师
57+
- 产品经理
58+
- 其它非技术用户
59+
60+
希望快速体验 Omen 而勿须本地安装,请访问我们部署在 Streamlit Cloud 的在线演示应用,快速查看效果。
61+
62+
你可以直接在线探索战略推演流程:
63+
64+
[👉 在线体验 Omen](https://omen-demo.streamlit.app)
65+
66+
---
67+
68+
## 🚀 快速上手
69+
70+
如果你是:
71+
72+
- 数据科学家
73+
- AI 研究者
74+
- 技术战略分析师
75+
- 其它技术用户
76+
77+
希望在本地环境中运行 Omen,请继续阅读以下安装和运行指南。
5178

5279
### 🏗️ 安装
5380

@@ -60,19 +87,21 @@ pip install --upgrade pip setuptools wheel
6087
pip install -e .
6188
```
6289

63-
### 🌰 看个例子
90+
### 🌰 看例子
6491

65-
如果你希望快速查看 Omen 的运行效果,`sample` 目录中提供了可视化案例及其结果。运行:
92+
如果你希望快速查看 Omen 的运行效果,`demo` 目录中提供了可视化案例及其结果。运行:
6693

6794
```bash
68-
streamlit run sample/app/scenario_planning.py
95+
streamlit run demo/app/scenario_planning.py
6996
```
7097

71-
然后在浏览器中打开 `http://localhost:8501`,即可查看完整的战略推演流程。
98+
在浏览器中打开 `http://localhost:8501`,即可查看完整的战略推演流程。
7299

73100
### 🎵 亲自运行
74101

75-
如果你希望亲自运行一遍完整的流程,请使用我们准备的内置案例,用于模拟 2026 年 3 月 SAP 收购 Reltio 的情境。案例文档位于 `cases/sap_reltio_acquisition.md`,可以通过以下步骤端到端运行。
102+
如果你希望亲自运行一遍完整的**分析——模拟——解释**流程,请使用我们准备的内置案例,用于模拟 2026 年 3 月 SAP 收购 Reltio 的情境。
103+
104+
案例文档位于 `cases/situations/sap_reltio_acquisition.md`,可以通过以下步骤端到端运行。
76105

77106
#### 第一步:分析
78107

@@ -152,17 +181,17 @@ Omen 专为以下角色打造:
152181

153182
### 战略主体分析
154183

155-
* [👤 Elon Musk](cases/actors/elon-musk.md)
156-
* [👤 Jeff Bezos](cases/actors/jeff-bezos.md)
157-
* [👤 Steve Jobs](cases/actors/steve-jobs.md)
158-
* [👤 Jack Ma](cases/actors/jack-ma.md)
159-
* [👤 Chen Jiaxing (me)](cases/actors/chen-jiaxing.md)
184+
* 👤 [Elon Musk](cases/actors/elon-musk.md)
185+
* 👤 [Jeff Bezos](cases/actors/jeff-bezos.md)
186+
* 👤 [Steve Jobs](cases/actors/steve-jobs.md)
187+
* 👤 [Jack Ma](cases/actors/jack-ma.md)
188+
* 👤 [Chen Jiaxing (me)](cases/actors/chen-jiaxing.md)
160189

161190
### 战略推演案例
162191

163-
* [🧩 SAP 收购 Reltio:主数据迷雾](cases/situations/sap_reltio_acquisition.md)
164-
* [🗺️ 本体论博弈:数据库 vs AI 记忆](cases/ontology.md)
165-
* [⚔️ 向量数据库 vs AI 记忆](cases/vector-memory.md)
192+
* 🧩 [SAP 收购 Reltio:主数据迷雾](cases/situations/sap_reltio_acquisition.md)
193+
* 🗺️ [本体论博弈:数据库 vs AI 记忆](cases/ontology.md)
194+
* ⚔️ [向量数据库 vs AI 记忆](cases/vector-memory.md)
166195

167196
更多场景持续构建中(欢迎贡献):
168197
* `智能体基础设施` vs `工作流平台`
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ def _read_json_file(*, base_dir: Path, pack_id: str, filename: str) -> dict[str,
6363

6464
def _load_sample_actor_payloads(pack_id: str) -> dict[str, Any]:
6565
safe_pack_id = _normalize_pack_id(pack_id)
66-
actor_dir = Path("sample/data/actors") / safe_pack_id
67-
actor_base = Path("sample/data/actors")
66+
actor_dir = Path("demo/data/actors") / safe_pack_id
67+
actor_base = Path("demo/data/actors")
6868
actor_profile_path = actor_dir / "actor_ontology.json"
6969
persona_path = actor_dir / "analyze_persona.json"
7070
status_path = actor_dir / "analyze_status.json"
@@ -585,9 +585,9 @@ def _render_flow_fallback(payloads: dict[str, Any]) -> None:
585585

586586
with st.sidebar:
587587
st.header("Sample Data Source")
588-
st.warning("Demo mode: this app reads bundled sample artifacts only.")
589-
DATA_ROOT = "sample/data/scenarios"
590-
OUTPUT_ROOT = "sample/output"
588+
st.warning("Demo mode: this app reads bundled demo artifacts only.")
589+
DATA_ROOT = "demo/data/scenarios"
590+
OUTPUT_ROOT = "demo/output"
591591
st.caption(f"Data root: {DATA_ROOT}")
592592
st.caption(f"Output root: {OUTPUT_ROOT}")
593593

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)