ReflectWorld

(โ˜… 96)

ReflectWorld-MM: An Entity-Oriented Multimodal Memory System for Open-Ended Video Stream

  • .env.example
  • .gitignore
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • eslint.config.mjs
  • LICENSE
  • package-lock.json
  • package.json
  • README.md
  • SECURITY.md
  • THIRD_PARTY_NOTICES.md
  • tsconfig.base.json
  • tsconfig.eval.json
  • tsconfig.json
  • vitest.config.ts

# Installation Guide

1. Get the code
git clone https://github.com/addxai/ReflectWorld

Downloads the entire project code from GitHub to your computer.

cd ReflectWorld

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm run build

Builds optimized production files.

npm run benchmark:setup

Type this command into your terminal and run it.

npm run benchmark:run -- --dataset ~/benchmark-data/dataset.json --smoke

Type this command into your terminal and run it.

npm run dashboard:demo

Type this command into your terminal and run it.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install -r eval/benchmark/lmms/memory_api/service_template/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.
// repository documentation