Skip to content

Latest commit

 

History

History
183 lines (120 loc) · 6.12 KB

README.md

File metadata and controls

183 lines (120 loc) · 6.12 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Idea connector

A note taking app that shows you how your ideas connect.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

Product Name Screen Shot

This is for connecting and finding sources for different ideas that you have in different text documents. For example, if you have a folder of source texts (like textbooks, articles, and your other writings), as you write, the most relevant sentences and paragraphs to your writing will appear in the suggetions column.

Built With

Simple Tensorflow Serving

Universal Sentence Encoder

Hnswlib

Django

Getting Started

You should have at least 6 GB of RAM to be able to run the Universal Sentence Encoder Model.

Prerequisites

TODO

Installation

Run startup script

./setup.sh

Usage

Include the .txt files that you would like to embed in the "sources" folder. Paragraphs should be separated by \n\n (enter key two times). Then, start a new document in either the "docs" location or the "sources" location and paste or start typing text. Suggestions will pop up on the other side of the browser.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Raymond Xu - raymond.y.xu@gmail.com

Project Link: https://github.com/ryx2/idea-connector

Acknowledgements