soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions
brainy/README.demo.md
David Snelling 5f267b14ed **feat(tests): add tests for TextEncoder, TensorFlow.js, and fallback mechanisms** 
- Introduced `test-fallback-function.js` and `test-fallback-simple.js` to validate `executeInThread` fallback functionality with both named and anonymous compute-intensive functions.
- Added `test-tensorflow-textencoder.js` for TensorFlow.js and TextEncoder tests in a Node.js environment.
- Created `test-tensorflow-textencoder.html` for browser-based TensorFlow.js and TextEncoder tests.
- Implemented cross-environment test support in `cli-package/src/test-tensorflow-textencoder.ts` for CLI functionality.
- Enhanced `src/utils/embedding.ts`, `textEncoding.ts`, and `brainy-wrapper.js` to include updated global `TextEncoder` and `TextDecoder` utilities for compatibility and worker improvements.
- Standardized and expanded utility methods in `PlatformNode` for broader support, including `isFloat32Array` and `isTypedArray` checks.
- Updated Node.js requirement to `>= 24.4.0` across documentation and configuration files for compatibility improvements.

This update introduces comprehensive testing for fallback mechanisms, TensorFlow.js, and TextEncoder across multiple environments, ensuring robustness and compatibility.
2025-07-11 11:11:56 -07:00

1.8 KiB
Raw Blame History

Running the Brainy Demo

The Brainy interactive demo showcases the library's features in a web browser. Follow these steps to run it:

Prerequisites

  • Make sure you have Node.js installed (version 24.4.0 or higher)
  • Ensure the project is built (run both npm run build and npm run build:browser)

Running the Demo

Option 1: Using the npm script (recommended)

Run the following command from the project root:

npm run demo

This will start an HTTP server and automatically open the demo in your default browser.

Option 2: Manual setup

  1. Start an HTTP server in the project root:
npx http-server
  1. Open your browser and navigate to: http://localhost:8080/demo/index.html

Troubleshooting

If you see the error "Could not load Brainy library. Please ensure the project is built and served over HTTP", check the following:

  1. Make sure you've built the project with npm run build:all
  2. Ensure you're accessing the demo through HTTP (not by opening the file directly)
  3. Check your browser's console for additional error messages

If issues persist, try clearing your browser cache or using a private/incognito window.

Build Process

The Brainy library uses a two-step build process:

  1. npm run build - Compiles TypeScript files to JavaScript (used for Node.js environments)
  2. npm run build:browser - Creates a browser-compatible bundle using Rollup

You can run both steps together with:

npm run build && npm run build:browser

Or simply use the demo script which does this for you:

npm run demo

The browser bundle is created from src/unified.ts, which provides environment detection and adapts to browser, Node.js, or serverless environments. This unified approach ensures that the library works correctly across all environments.