You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-9Lines changed: 18 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,16 @@
2
2
3
3
This is Codeinterpreter-codebox, a cloud service for executing Code Interpreter code.
4
4
5
-
# Features
5
+
## 📜 Table of Contents
6
+
-[🎯 Key Features](#-key-features)
7
+
-[💡 What Can You Do?](#-what-can-you-do)
8
+
-[📋 Related Projects & Their Differences](#-related-projects--their-differences)
9
+
-[💻 Sample Codes](#-sample-codes)
10
+
-[📦 Deployment](#-deployment)
11
+
-[📧 Contact](#-contact)
12
+
13
+
## 🎯 Key Features
14
+
6
15
1. 🐍 **Independent Jupyter Sandbox Environment**
7
16
A completely isolated Jupyter sandbox environment that supports state-preserving code execution. Supports file uploads and downloads.
8
17
2. 🐳 **Dockerized One-click Deployment**
@@ -12,7 +21,7 @@ Supports completely private deployments without the need to upload files to exte
12
21
5. 🚀 **More Flexible**
13
22
Supports the opening of more ports to achieve more custom functionality requirements, such as: connecting to databases, connecting to the internet, connecting to other servers.
14
23
15
-
## Function Descriptions
24
+
## 💡 What Can You Do?
16
25
1. Execute Python code.
17
26
2. Supports reading of uploaded files ([Upload and Analyze Files](./examples/client/codeinterpreter_session.py)).
18
27
```
@@ -28,7 +37,7 @@ session.close()
28
37
4. Supports dynamic scaling for commercial deployments.
29
38
5. Supports custom feature modifications, open ports, network connections, etc., supports web crawlers.
1.[jupyter server communicate](./examples/jupyter/jupyter_api_test.ipynb) showcases the details of interaction between the server and the Jupyter container.
50
-
2.[jupyter call](./examples/jupyter/execute_dynamic_code.ipynb) demonstrates how to invoke a web service via an HTTP request, execute code, and retrieve results.
57
+
## 💻 Sample Codes
58
+
1.**Server-Client Interaction**: [jupyter server communicate](./examples/jupyter/jupyter_api_test.ipynb) showcases the details of interaction between the server and the Jupyter container.
59
+
2.**Remote Execution**: [jupyter call](./examples/jupyter/execute_dynamic_code.ipynb) demonstrates how to invoke a web service via an HTTP request, execute code, and retrieve results.
3.[client session invocation](./examples/client/codeinterpreter_session.py) shows how to allow LLM to invoke and execute code in a project through session and HTTP request.
71
+
3.**Client Session Demonstration**: [client session invocation](./examples/client/codeinterpreter_session.py) shows how to allow LLM to invoke and execute code in a project through session and HTTP request.
63
72
```
64
73
session=CodeinterpreterSession()
65
74
try:
@@ -70,9 +79,9 @@ session.close()
70
79
```
71
80
72
81
73
-
## Deployment
82
+
## 📦 Deployment
74
83
In [docker compose](./app/docker_dev.yml), replace 'CODEBOX_ROOT_PATH' and 'YOUR_MNT_PATH:/codebox' with your own file path for 'YOUR_MNT_PATH' to mount.
0 commit comments