Skip to content

Commit 8a0f4a7

Browse files
committed
update docs
1 parent 1978070 commit 8a0f4a7

File tree

2 files changed

+10
-16
lines changed

2 files changed

+10
-16
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Adjust settings for your use case:
2222
- Verify all configurations
2323
- Execute workflow for automated processing
2424
- View results at the specified output path
25-
- [API Loading and Execution](api_integration.md)
25+
- [API Loading and Execution](deploy.md)
2626

2727

2828
## Complete List

api_integration.md renamed to deploy.md

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

22
# API Integration
33

4-
## 🔧 Custom Input/Output Mode
4+
- Development Phase: Design and debug workflows using the visual interface. **Develop custom nodes when necessary**
5+
- Deployment Phase: Export JSON configuration and load via API
56

6-
**Use Cases**: Dynamic input data setting in code, or custom output result processing
7+
Whether through visual interface or API calls, all workflows execute in the unified high-performance C++ compute engine, ensuring consistency between development and deployment environments.
78

8-
**Core Steps**:
9+
## Custom Input/Output Mode
910

10-
1. Remove input/output nodes from the workflow
11-
2. Set input data through code
12-
3. Retrieve and process output results
11+
**Use Cases**: Dynamic input data setting in code and custom output result processing
1312

14-
**Python Example**:
13+
**Python LLM Example**:
1514

1615
```python
1716
import nndeploy
@@ -39,7 +38,7 @@ result = output_edge.get_graph_output()
3938
graph.deinit()
4039
```
4140

42-
**C++ Example**:
41+
**C++ LLM Example**:
4342

4443
```cpp
4544
#include "nndeploy/dag/graph.h"
@@ -69,7 +68,7 @@ tokenizer::TokenizerText* result = output->getGraphOutput<tokenizer::TokenizerTe
6968
status = graph->deinit();
7069
```
7170
72-
## 🎯 Complete Workflow Mode
71+
## Complete Workflow Mode
7372
7473
**Use Cases**: Workflow contains complete input/output processing logic, no additional data setup required
7574
@@ -99,16 +98,11 @@ status = graph->deinit();
9998
10099
---
101100
102-
## 📚 Example Code
101+
## Example Code
103102
104103
| Algorithm Type | Python Example | C++ Example |
105104
| -------------- | -------------- | ----------- |
106105
| **Large Language Model** | [Python LLM](https://github.com/nndeploy/nndeploy/blob/main/demo/llm/demo.py) | [C++ LLM](https://github.com/nndeploy/nndeploy/blob/main/demo/llm/demo.cc) |
107106
| **Object Detection** | [Python Detection](https://github.com/nndeploy/nndeploy/blob/main/demo/detect/demo.py) | [C++ Detection](https://github.com/nndeploy/nndeploy/blob/main/demo/detect/demo.cc) |
108107
109-
## 🚀 Recommended Development Workflow
110108
111-
- Development Phase: Design and debug workflows using the visual interface. **Develop custom nodes when necessary**
112-
- Deployment Phase: Export JSON configuration and load via API
113-
114-
Whether through visual interface or API calls, all workflows execute in the unified high-performance C++ compute engine, ensuring consistency between development and deployment environments.

0 commit comments

Comments
 (0)