Skip to content

Commit 5513912

Browse files
committed
add readme
1 parent 3c7b14e commit 5513912

File tree

2 files changed

+29
-3
lines changed

2 files changed

+29
-3
lines changed

DEVELOPMENT.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,25 @@ How to set up your local machine.
2020
```
2121
- **Configure environment variable (optional)s**
2222
- copy `api-keys.env.example` to `api-keys.env` and add your API keys.
23-
- required fields for different providers are different, please refer to the [LiteLLM setup](https://docs.litellm.ai/docs#litellm-python-sdk) guide for more details.
24-
- currently only endpoint, model, api_key, api_base, api_version are supported.
25-
- this helps data formulator to automatically load the API keys when you run the app, so you don't need to set the API keys in the app UI.
23+
- required fields for different providers are different, please refer to the [LiteLLM setup](https://docs.litellm.ai/docs#litellm-python-sdk) guide for more details.
24+
- currently only endpoint, model, api_key, api_base, api_version are supported.
25+
- this helps data formulator to automatically load the API keys when you run the app, so you don't need to set the API keys in the app UI.
26+
27+
- set `.env` to configure server properties:
28+
- copy `.env.template` to `.env`
29+
- configure settings as needed:
30+
- DISABLE_DISPLAY_KEYS: if true, API keys will not be shown in the frontend
31+
- EXEC_PYTHON_IN_SUBPROCESS: if true, Python code runs in a subprocess (safer but slower), you may consider setting it true when you are hosting Data Formulator for others
32+
- LOCAL_DB_DIR: directory to store the local database (uses temp directory if not set)
33+
- External database settings (when USE_EXTERNAL_DB=true):
34+
- DB_NAME: name to refer to this database connection
35+
- DB_TYPE: mysql or postgresql (currently only these two are supported)
36+
- DB_HOST: database host address
37+
- DB_PORT: database port
38+
- DB_DATABASE: database name
39+
- DB_USER: database username
40+
- DB_PASSWORD: database password
41+
2642
2743
- **Run the app**
2844
- **Windows**

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ Transform data and create rich visualizations iteratively with AI 🪄. Try Data
2222

2323
## News 🔥🔥🔥
2424

25+
- [04-23-2025] Data Formulator 0.2: working with *large* data 📦📦📦
26+
- Explore large data by:
27+
1. Upload large data file to the local database (powered by [DuckDB](https://github.com/duckdb/duckdb)).
28+
2. Use drag-and-drop to specify charts, and Data Formulator dynamically fetches data from the database to create visualizations (with ⚡️⚡️⚡️ speeds).
29+
3. Ask AI agents a new exploration question, and they generate SQL queries to transform the data to create rich visualizations!
30+
4. Anchor the result, follow up, create a new branch, and join tables to dive deeper.
31+
- Checkout the demos at [[https://github.com/microsoft/data-formulator/releases/tag/0.2]](https://github.com/microsoft/data-formulator/releases/tag/0.2)
32+
- Improved overall system performance, and enjoy the updated derive concept functionality.
33+
- `pip install --upgrade data-formulator` now!
34+
2535
- [03-20-2025] Data Formulator 0.1.7: Anchoring ⚓︎
2636
- Anchor an intermediate dataset, so that followup data analysis are built on top of the anchored data, not the original one.
2737
- Clean a data and work with only the cleaned data; create a subset from the original data or join multiple data, and then focus your analysis from there. The AI agent will be less likely to get confused and work faster. ⚡️⚡️

0 commit comments

Comments
 (0)