Git Product home page Git Product logo

instagraph's Introduction

Note for non-coders: you can sign up for the waitlist at instagraph.ai.

InstaGraph 🌐

Hello there, adventurous coder! Welcome to InstaGraph, your go-to application for converting text or URLs into insightful knowledge graphs. Curious about the relationships between entities in a complex topic? Feed the text to InstaGraph and voila! A beautiful knowledge graph is at your fingertips.

See example flowcharts generated by InstaGraph here.

Powered by OpenAI's GPT-3.5, this Flask application turns your text into a vividly colored graph, making it easier to visualize relationships between various entities. Enough talkingβ€”let's get started!

Author's TL;DR: If you're just looking for how the knowledge graph is generated, check out the function call parameters taking up half of main.py.

Table of Contents πŸ“š

Features 🌟

  • Dynamic Text to Graph conversion.
  • Color-coded graph nodes and edges.
  • Responsive designβ€”use it on any device.
  • Super-duper user-friendly!

Installation πŸ› οΈ

To get started, you'll need Python and pip installed.

1. Clone the repository

git clone https://github.com/yoheinakajima/instagraph.git

2. Navigate to the project directory

cd instagraph

3. Install the required Python packages

pip install -r requirements.txt

4. Set up your OpenAI API Key

Change .env.example to .env

mv .env.example .env

Add your OpenAI API key to .env file:

OPENAI_API_KEY=your-api-key-here
Optional

Add Neo4J username, password and URL in the *.env file as well.

NEO4J_USERNAME=
NEO4J_PASSWORD=
NEO4J_URL=

5. Run the Flask app

python main.py

Navigate to http://localhost:8080 to see your app running.

Run as Container

1. Clone the repository

git clone https://github.com/yoheinakajima/instagraph.git

2. Navigate to the project docker directory

cd instagraph/docker

3.1 Run in Dev mode

docker-compose -f docker-compose-dev.yml up # Add -d flag at the end to run in background/daemon mode.

3.2 Run in Prod - Create the docker image

  • Using the gunicorn==21.2.0 to run the application in production mode
docker-compose -f docker-compose.yml up --build -d

Usage πŸŽ‰

Web Interface

  • Open your web browser and navigate to http://localhost:8080.
  • Type your text or paste a URL in the input box.
  • Click "Submit" and wait for the magic to happen!

API Endpoints

  1. GET Response Data: /get_response_data

    • Method: POST
    • Data Params: {"user_input": "Your text here"}
    • Response: GPT-3.5 processed data
  2. GET Graph Data: /get_graph_data

    • Method: POST
    • Response: Graph Data
  3. GET History Data: /get_graph_history

    • Method: GET
    • Response: Graph Data

Contributing 🀝

Best way to chat with me is on Twitter at @yoheinakajima. I usually only code on the weekends or at night, and in pretty small chunks. I have lots ideas on what I want to add here, but obviously this would move faster with everyone. Not sure I can manage Github well given my time constraints, so please reach out if you want to help me run the Github. Now, here are a few ideas on what I think we should add based on comments...

  • Store knowlege graph (thx @tomasonjo! 9/13/23)
  • Pull knowledge graph from storage (thx @tomasonjo! 9/13/23)
  • Show history
  • Ability to combine two graphs
  • Ability to combine 2+ graphs from history
  • Ability to expand on a graph (thx @tomasonjo! 9/13/23)
  • Ability to expand on graph from specific nodes
  • Fuzzy matching of nodes for combining graphs (vector match + LLM confirmation)

There are a lot of "build a chart" tools out there, so instead of doing user account and custom charts, it sounds more fun for me to work on building the largest knowledge graph ever...

Before creating an Issue please refer the ISSUE_TEMPLATE provided.

License πŸ“

MIT License. See LICENSE for more information.


Enjoy using InstaGraph! πŸŽ‰

instagraph's People

Contributors

yoheinakajima avatar shepherd-06 avatar prasantpoudel avatar alexweberk avatar dogukanurker avatar shashankshet avatar velocitatem avatar eltociear avatar lukafin avatar vizsumit avatar tomasonjo avatar sagardobariya avatar treee97 avatar

Stargazers

trinsition avatar linroger avatar  avatar Yetmens avatar zhiquan036 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.