florian-kalisch / auto-mindmapping

Revolutionize your mind mapping with this repo, combining mermaid and GPT-3.5-turbo / GPT-4! Craft captivating mindmaps for brainstorming and text summarization, unlocking creativity and productivity. Experience this trailblazing solution for the ultimate mind mapping experience today! Don't miss out and elevate your creative thinking skills!

Automated Mindmapping with GPT and Mermaid

This repository houses a project that enables automatic creation of mindmaps using OpenAI's GPT-3.5-turbo and GPT-4 models, with the support of Mermaid for mindmap visualizations.

About

The system comes with built-in system prompts for brainstorming, text summarization, and cause/effect visualization. The integration of GPT models provides the power of language understanding, while Mermaid enables rich and customizable visual representations.

What does the project say about advantages and disadvantages of automated mindmapping (note that GitHub doesn't seem to support the icons)? This is the generated mermaid code (available under Output):

mindmap
	root("Automated Mind Mapping using Large Language Models")
		["Advantages"]
		::icon(fa fa-thumbs-up)
			("Efficient and time-saving")
			::icon(fa fa-clock)
			("Easily customizable and adaptable")
			::icon(fa fa-cogs)
			("Improved collaboration and communication")
			::icon(fa fa-users)
			("Supports creative thinking and idea generation")
			::icon(fa fa-lightbulb)
			("Accessible and shareable")
			::icon(fa fa-share-alt)
			("Scalable for large data sets")
			::icon(fa fa-expand-arrows-alt)
			("Minimizes human error")
			::icon(fa fa-exclamation-triangle)
			("Integrates with other tools and platforms")
			::icon(fa fa-link)
		["Disadvantages"]
		::icon(fa fa-thumbs-down)
			("Requires reliable and accurate data")
			::icon(fa fa-database)
			("Potential for privacy and security concerns")
			::icon(fa fa-shield-alt)
			("Dependent on quality of language model")
			::icon(fa fa-brain)
			("May not capture nuances and subtleties")
			::icon(fa fa-adjust)
			("Limited by AI understanding of context")
			::icon(fa fa-glasses)
			("Potential for bias in AI-generated content")
			::icon(fa fa-balance-scale)
			("Requires regular maintenance and updates")
			::icon(fa fa-wrench)
			("May be expensive to implement and maintain")
			::icon(fa fa-dollar-sign)
			("Lack of personal touch in content")

Loading

view at mermaid.live

Features

• Utilizes gpt-3.5-turbo, gpt-3.5-turbo-16k, gpt-4, gpt-4-turbo models for mindmap generation
• Supports prompts for brainstorming, text summarization, and cause/effect visualizations
• Outputs mindmaps in Mermaid syntax
• Provides a visual representation of mindmaps
• Offers a convenient way to save generated mindmap images

Known Limitations

• The system may sometimes produce inaccurate information due to the current limitations of Large Language Models (LLMs).
• There might be occasional inconsistencies in style.
• Sometimes, the output isn't valid Mermaid syntax (you can then edit the mermaid code under output).
• When saving the image, the Font Awesome icons might look different from what is shown on the screen.
• Due to iOS limitations the text area elements can't be resized

Getting Started

Online

Prerequisites

Ensure you have access to OpenAI's API with models like gpt-3.5-turbo, gpt-3.5-turbo-16k, gpt-4, gpt-4-turbo.

It should be obvious, but: Using the API will result in request-based costs (it is not part of the ChatGPT / Subscription).

Quickstart

The fastest way would be https://florian-kalisch.github.io/auto-mindmapping/

Offline

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have installed the latest version of Node.js and npm.
• You have a recent version of Yarn installed.
• Ensure you have access to OpenAI's API with models like gpt-3.5-turbo, gpt-3.5-turbo-16k, gpt-4, gpt-4-turbo.

It should be obvious, but: Using the API will result in request-based costs (it is not part of the ChatGPT / Subscription).

Clone and run

To start using the project, follow these steps:

1. Clone the repository:

git clone https://github.com/florian-kalisch/auto-mindmapping.git

2. Navigate into the project directory:

cd auto-mindmapping

3. Install the required dependencies using Yarn:

yarn install

3. Start the React development server:

yarn start

Your application should be running on localhost:3000/auto-mindmapping

Usage

Settings

Under the Settings tab you have to enter your OpenAI API token. The default model is gpt-3.5-turbo.

You can set max tokens and temperature based on your needs (will be saved to localStorage). For brainstorming a higher temperature might be good.

Prompt Template shows you the system prompt. You can customize it to achieve more or better results (will be saved to localStorage).

Mindmapping

With Prompt you can input your request. You can ask "Brainstorming for weekend activities on a sunny weekend" and get a mindmap for this topic. You can input text and you get a mind map summarizing the text. You can ask for "Mindmap for: What are the consequences if it rains." and you see what might happen then.

Sometimes the output contains the typical GPT chatter text. In this case, Mermaid does not recognize valid syntax. To avoid this, the streamed text would need to be edited/cleaned up, or at least some post-processing would need to be done. This is currently missing. To work around this problem, you can simply try again. It might also be helpful to include "brainstorm" or "mind map" in your command prompt.

To save your result, you can either copy the mermaid code from "Output" or save the image.

Further Reading

Please take a look at the following resources to better understand the project:

• https://react.dev/
• OpenAI API
• Mermaid Syntax

auto-mindmapping's Issues

api

Hi florian, I installed it on my computer and the project opened, I clicked the create button, but it didn't work, I wonder if there is a place where I need to enter the api key.