[go: up one dir, main page]

Skip to content

microsoft/data-formulator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Data Formulator icon Data Formulator: Create Rich Visualizations with AI

arxiv  License: MIT  YouTube  build

Transform data and create rich visualizations iteratively with AI πŸͺ„. Try Data Formulator now in GitHub Codespaces!

Open in GitHub Codespaces

News πŸ”₯πŸ”₯πŸ”₯

  • [10-11-2024] Data Formulator python package released!

    • You can now install Data Formulator using Python and run it locally, easily. [check it out].
    • Our Codespaces configuration is also updated for fast start up ⚑️. [try it now!]
    • New experimental feature: load an image or a messy text, and ask AI to parse and clean it for you(!). [demo]
  • [10-01-2024] Initial release of Data Formulator, check out our [blog] and [video]!

Overview

Data Formulator is an application from Microsoft Research that uses large language models to transform data, expediting the practice of data visualization.

Data Formulator is an AI-powered tool for analysts to iteratively create rich visualizations. Unlike most chat-based AI tools where users need to describe everything in natural language, Data Formulator combines user interface interactions (UI) and natural language (NL) inputs for easier interaction. This blended approach makes it easier for users to describe their chart designs while delegating data transformation to AI.

Get Started

Play with Data Formulator with one of the following options:

  • Option 1: Install via Python PIP

    Use Python PIP for an easy setup experience, running locally (recommend: install it in a virtual environment).

    # install data_formulator
    pip install data_formulator
    
    # start data_formulator
    data_formulator 
    
    # alternatively, you can run data formualtor with this command
    python -m data_formulator

    Data Formulator will be automatically opened in the browser at http://localhost:5000.

    Update: you can specify the port number (e.g., 8080) by python -m data_formulator --port 8080 if the default port is occupied.

  • Option 2: Codespaces (5 minutes)

    You can also run Data Formulator in Codespaces; we have everything pre-configured. For more details, see CODESPACES.md.

    Open in GitHub Codespaces

  • Option 3: Working in the developer mode

    You can build Data Formulator locally if you prefer full control over your development environment and the ability to customize the setup to your specific needs. For detailed instructions, refer to DEVELOPMENT.md.

Using Data Formulator

Once you’ve completed the setup using either option, follow these steps to start using Data Formulator:

The basics of data visualization

  • Provide OpenAI keys and select a model (GPT-4o suggested) and choose a dataset.
  • Choose a chart type, and then drag-and-drop data fields to chart properties (x, y, color, ...) to specify visual encodings.
renewable.mp4

Create visualization beyond the initial dataset (powered by πŸ€–)

  • You can type names of fields that do not exist in current data in the encoding shelf:
    • this tells Data Formulator that you want to create visualizations that require computation or transformation from existing data,
    • you can optionally provide a natural language prompt to explain and clarify your intent (not necessary when field names are self-explanatory).
  • Click the Formulate button.
    • Data Formulator will transform data and instantiate the visualization based on the encoding and prompt.
  • Inspect the data, chart and code.
  • To create a new chart based on existing ones, follow up in natural language:
    • provide a follow up prompt (e.g., ``show only top 5!''),
    • you may also update visual encodings for the new chart.
renewable-pct.mp4
renewable-rank.mp4

Repeat this process as needed to explore and understand your data. Your explorations are trackable in the Data Threads panel.

Developers' Guide

Follow the developers' instructions to build your new data analysis tools on top of Data Formulator.

Research Papers

@article{wang2024dataformulator2iteratively,
      title={Data Formulator 2: Iteratively Creating Rich Visualizations with AI}, 
      author={Chenglong Wang and Bongshin Lee and Steven Drucker and Dan Marshall and Jianfeng Gao},
      year={2024},
      booktitle={ArXiv preprint arXiv:2408.16119},
}
@article{wang2023data,
  title={Data Formulator: AI-powered Concept-driven Visualization Authoring},
  author={Wang, Chenglong and Thompson, John and Lee, Bongshin},
  journal={IEEE Transactions on Visualization and Computer Graphics},
  year={2023},
  publisher={IEEE}
}

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.