Commit graph

40 commits

Author SHA1 Message Date
214865af08 remove: embedded image data from README.md to reduce file size 2025-06-11 10:00:16 -07:00
90ce85fecc Embed brainy.png image directly in README.md for better visibility 2025-06-11 09:52:25 -07:00
04daa9ff0d fix: update logo URL in README.md to use absolute GitHub path 2025-06-11 09:36:46 -07:00
a71ca50815 fix: add extra line breaks in README.md for better spacing 2025-06-11 09:31:59 -07:00
6de25d85eb fix: update logo source path in README.md 2025-06-11 09:31:23 -07:00
f28eef6df9 fix: update image source path in README.md 2025-06-11 09:23:48 -07:00
b6a33be76d fix: update image source path in README.md 2025-06-11 09:22:00 -07:00
3c16ea34c6 feat: add script for encoding images to Base64 and generating HTML output
Introduced `encode-image.js` to convert images to Base64 and create corresponding HTML `<img>` tags. Outputs a sample encoded result to `encoded-image.html`.
2025-06-11 09:17:17 -07:00
9b4ac287e6 chore: update README.md with logo alignment and define package file inclusions
Added spacing adjustment for Brainy logo in README. Specified files to be included in package publication to streamline distribution.
2025-06-11 08:58:19 -07:00
0b7b3f947b chore: update README.md and docs with Brainy logo and enhanced formatting
Standardized documentation by adding a centered Brainy logo across README files, examples, and guides. Adjusted text formatting for consistency, improved alignment, and readability of feature descriptions and examples.
2025-06-11 08:49:30 -07:00
7f95844434 docs: add comprehensive documentation and examples for LLM augmentation
Introduced `llm-augmentation.md`, detailing the creation, training, testing, exporting, and deployment of language models using Brainy's graph database. Added examples showcasing practical usage and pipeline integration. Included class implementations in `llmAugmentations.ts`.
2025-06-10 11:15:22 -07:00
bf3d9a055b feat: implement remote server search capabilities with WebSocket support 2025-06-06 10:48:01 -07:00
6ccbd01654 docs: enhance README.md with new badges, iConduit details, and related projects
Added several badges for TypeScript, TensorFlow, and Cartographer. Expanded on iConduit augmentations with WebSocket and WebRTC details, revised feature descriptions, and introduced a related projects section. Updated examples for improved clarity.
2025-06-06 09:33:39 -07:00
6feab06f34 feat: add cloud deployment support and contribution guidelines
Introduced a cloud deployment wrapper for Brainy supporting AWS Lambda, Google Cloud Run, and Cloudflare Workers. Added configuration options, deployment scripts, and API reference. Updated `README.md` with contribution guidelines and cloud deployment documentation.
2025-06-06 09:08:33 -07:00
d7bb6e7d5f chore: update to version 0.7.5, add conduit augmentations, and sync README.md
Incremented version to 0.7.5 across `version.ts` and `README.md`. Introduced WebSocket and WebRTC conduit augmentations in codebase and documented usage examples thoroughly in `README.md`.
2025-06-06 08:48:50 -07:00
783b40083f docs: simplify README.md and rebrand to "Brainy"
Rebranded from "Soulcraft Brainy" to "Brainy" throughout `README.md`. Improved readability by reformatting long paragraphs and restructuring lists for better clarity.
2025-06-06 08:10:55 -07:00
32d5f45552 chore: update Node.js requirement to 23.11.0 and optimize pipelines and utilities
Upgraded minimum Node.js version from 18.0.0 to 23.11.0 across `README.md`, `package.json`, and `version.ts`. Optimized distance utilities and pipelines to leverage Node.js 23.11+ native performance improvements (e.g., `array.reduce`, WebStreams API). Incremented version to 0.7.4 for consistency.
2025-06-05 14:51:21 -07:00
e35e07d298 chore: sync README.md with version updates and enhance versioning script
Updated `README.md` to reflect version `0.7.3` with improved feature descriptions and scaling highlights. Enhanced the versioning script to automatically update the version badge in `README.md` for consistency. Incremented `version.ts` to `0.7.3`.
2025-06-05 14:25:29 -07:00
633846e54a docs: revamp README.md with engaging descriptions and expand feature list
Enhanced the `README.md` with more engaging and user-friendly descriptions, highlighting Brainy's adaptability and intelligence. Introduced new sections detailing adaptive intelligence, data pipeline enhancements, and use case expansion. Removed outdated dependencies from `package-lock.json`. Updated `version.ts` to `0.7.2`.
2025-06-05 14:12:50 -07:00
e2f65c8146 feat: add random graph generation and improve metadata vectorization
Introduced `generateRandomGraph` method to create randomized graphs with configurable entity counts and types, supporting automated testing and experimentation. Enhanced metadata vectorization logic to handle various metadata formats reliably, ensuring compatibility and fallback mechanisms during embedding. Updated `README.md` with detailed feature descriptions and usage guides.
2025-06-05 14:04:29 -07:00
be67c1b753 docs: update README.md and suppress TensorFlow.js warnings
Enhanced the installation section with guidance on resolving TensorFlow.js dependency conflicts using `--legacy-peer-deps`. Added CLI autocomplete setup instructions to improve user experience. Suppressed specific TensorFlow.js Node.js backend warnings in the embedding utils. Updated dependencies to the latest versions.
2025-06-05 11:44:18 -07:00
cdbd2a9db4 feat: introduce CLI for Brainy and enhance type validation
Added a comprehensive command-line interface (CLI) for interacting with the Brainy vector database. The CLI supports various operations, including database initialization, adding/searching nouns, managing relationships, and querying database status. Enhanced type validation logic for nouns and verbs to ensure consistency and enforce default types for invalid inputs. Updated test scripts to verify type validation and edge cases.
2025-06-05 11:18:20 -07:00
1644304bc8 docs: update README.md with detailed usage examples and refined feature descriptions
Expanded the documentation to include comprehensive usage scenarios, advanced configurations, and clearer explanations of Brainy's capabilities. Improved formatting and structure for better readability and accessibility.
2025-06-05 08:26:12 -07:00
100d4c7839 feat: add read-only database mode and S3-compatible storage options
Introduced configurable read-only mode for databases to restrict write operations. Added support for S3-compatible storage services, including Cloudflare R2, Amazon S3, and Google Cloud Storage. Updated `README.md` with usage examples and configuration details.
2025-06-04 10:00:00 -07:00
3659b0069b chore: temporarily disable Firestore functionality and remove Firebase dependencies
Commented out all Firestore-related code across the project, including sync, storage, and vector search features. Removed Firebase dependencies (`firebase`, `firebase-admin`) from `package.json`. Updated `README.md` to reflect the temporary unavailability of Firestore features.
2025-06-02 12:43:44 -07:00
9a4f1ab1f6 chore: update README.md with Firestore vector search fallback note, remove unused dependency from package.json 2025-06-02 12:29:39 -07:00
725610fbe4 feat: add Firestore vector search integration and noun type-based search enhancements
Introduced Firestore vector search integration using `@firebase/firestore-vector-search`. Added support for restricting searches by specific noun types to optimize performance and relevance. Updated `README.md` to document the new functionality and usage examples.
2025-06-02 12:23:11 -07:00
95a72f4181 chore: reformat code in README.md for improved readability
Applied consistent indentation and line-breaking rules to code and text sections in `README.md`, ensuring better formatting and alignment for readability. No functional changes made.
2025-05-29 10:29:52 -07:00
203b669203 chore: remove examples/externalPlugins.js and pluginLoader.ts, update imports to .js
Deleted `examples/externalPlugins.js` and `pluginLoader.ts` as they are no longer used. Updated all `.ts` imports to `.js` across the codebase. Added `MemberOf` to `VerbType` and filtered disabled augmentations in `executeAugmentationPipeline`. Updated documentation to reflect new augmentation registration process. Removed deprecated `allowImportingTsExtensions` from `tsconfig.json`.
2025-05-29 09:52:30 -07:00
b031a40b1c feat: add external plugin loader and examples for Brainy
Introduced `pluginLoader.ts` to enable loading and configuring augmentation plugins from external packages. Added `examples/externalPlugins.js` to demonstrate usage. Enhanced storage status reporting in `opfsStorage` and `BrainyData` with detailed storage capacity and usage methods. Updated README with an external plugin usage guide.
2025-05-28 15:39:14 -07:00
25986720d3 docs: add augmentation types import section to README and update type definitions
Added a new README section detailing how to import and use augmentation interfaces without pulling the entire library. Updated `package.json` exports to enable direct imports for augmentation types. Included example demonstrating custom augmentation implementation and usage.
2025-05-28 10:37:55 -07:00
ce9c5e2522 docs: add separate graph type import section to README and update type definitions
Introduced a new README section explaining how to import graph types individually to enable tree shaking. Updated `package.json` exports to support direct graph type imports. Enhanced `GraphNoun` structure by adding optional `label` and `embeddedVerbs` properties while simplifying the `CreatorMetadata` interface.
2025-05-28 09:56:24 -07:00
f73d3b0c97 docs: update README to reflect Graph and Vector database upgrade
Enhanced README to clarify the transition from a vector database to a combined Graph and Vector database, detailing support for graph entities, relationships, and full capabilities of the new data model. Updated examples and documentation accordingly.
2025-05-27 17:06:17 -07:00
d77b2bf8fe feat: enhance embedding functionality and improve TensorFlow.js integration
Enhanced embedding functionality by introducing `createTensorFlowEmbeddingFunction` and `createSimpleEmbeddingFunction` for flexible text vectorization. Updated TensorFlow.js dependencies to be automatically included with the package. Added detailed examples and documentation in `README.md`. Improved error handling and refactored default embedding function implementation. Updated `package.json` dependencies.
2025-05-27 15:11:12 -07:00
5566ddfb09 chore: remove example files and release configuration
Deleted augmentation pipeline examples and `.releaserc.json`, streamlining the repository by eliminating redundant example implementations and release automation files.
2025-05-27 13:58:49 -07:00
022680a2f5 feat: implement augmentation type system and release automation 2025-05-27 13:12:53 -07:00
d2ddbd2613 Add augmentation pipeline and memory augmentation documentation
Introduced an augmentation event pipeline supporting multiple execution modes (e.g., SEQUENTIAL, PARALLEL). Added new Memory Augmentation type for versatile data storage/retrieval (e.g., fileSystem, in-memory, Firestore). Updated `README.md` with pipeline usage, examples, and augmentations reorganization. Included new demo files for augmentation examples.
2025-05-27 10:08:01 -07:00
99bc4990bd Set package.json private flag to false for npm publication
Changed `"private"` to `false` in package.json to allow publishing the package to npm. The `"access": "restricted"` setting ensures that access remains limited to @soulcraft organization members. Updated README to reflect the new configuration.
2025-05-23 11:30:19 -07:00
7638506ffa Update package scope to @soulcraft and configure as private
Changed package name and imports to use the @soulcraft scope. Updated `README.md` to reflect the use of a private npm package and added publishing/installing instructions. Configured `package.json` with `private: true` and restricted access for publishing. Updated demo link to the correct GitHub repository.
2025-05-23 11:08:02 -07:00
49480e694c Initial commit of Brainy vector database v0.1.0 2025-05-23 10:55:20 -07:00