Git Product home page Git Product logo

kj3moraes / reader Goto Github PK

View Code? Open in Web Editor NEW

This project forked from freeman-jiang/nexus

0.0 0.0 0.0 14.71 MB

A 3D, interactive semantic graph of blog posts on Substack to aid reading discovery.

Home Page: https://reader-sable.vercel.app/

JavaScript 0.15% Python 0.14% TypeScript 0.01% CSS 0.01% HTML 0.01% Jupyter Notebook 99.69%
chromadb embeddings semantic-search vector-database

reader's Introduction

Reader - 3D Semantic Graph of a subset of Substack blogs

preview

You can view it here - https://reader-sable.vercel.app/

I built this project as an experiment and as something that could lead up to something I want. Essentially when I read blogs or posts on the internet and I really like them, I want to see more at that time. Yes, I know, I can follow the author and all but I want to know more authors writing about this stuff at that point in time.

This experiment was born out of that. And since I'm doing a lot of ML stuff, I decided to experiment with topic modelling. You can check it all out on my devlog - itskeane.info/blog/reader

Building

This process occurs in 4 steps

  1. Acquiring data by scraping Substack
  2. Cleaning the data by cleaning all the markdown files
  3. Topic modelling on the data
  4. Embedding the topics and other metadata for each post
  5. Building the graph by querying the vector database
  6. Reading the graph and bundling it.

For steps 1-5, refer to the HOW_TO.md for details on how to acquire the data.

6. Reading the graph

This was mostly borrowed from Nexus. I changed the stuff for accessing the nodes and how the panel displayed. When you finish steps 1-5, you should have a graphData.json file. This must be moved to the frontend folder.

Then you can run the following the frontend folder

npm i
npm run dev

This will build the bundle.js file and then you can view index.html. Any changes to index.js is then reflected.

Running

To run this, you need to follow the steps above and then navigate to the frontend/ directory and then

npm i
npm run start

This will generate a bundle.js and then you can open index.html in your favourite browser :).

WARNING: This is no way meant to be production ready. I cooked this up in a weekend. Please don't take it too seriously

References

The code is majorly forked from Nexus.

  • I made changes to the frontend for rendering.
  • I made changes to how the data is collected, stored, embedded and subsquently queried.
  • I reordered and deleted all the exiguous files.

reader's People

Contributors

freeman-jiang avatar leogjhuang avatar kj3moraes avatar rajansagarwal 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.