Skip to content

fix: update benchmark so it's buildable #731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 5, 2025

Conversation

srl295
Copy link
Contributor

@srl295 srl295 commented Mar 4, 2025

  • move files from .js to .mjs so they are usable as modules
  • shim __dirname using fileURLToPath
  • add a benchmark/README.md explaining the build process (such as it is)
  • update CONTRIBUTING.md to link to the new README.md
  • fix backslashes in CONTRIBUTING.md

Purpose / Goal

The benchmark wasn't usable or documented.

Fixes: #730

Type

Please mention the type of PR

  • Bug Fix
  • Refactoring / Technology upgrade
  • New Feature

Note : Please ensure that you've read contribution guidelines before raising this PR. If your PR is in progress, please prepend [WIP] in PR title. Your PR will be reviewed when [WIP] will be removed from the PR title.

Bookmark this repository for further updates.

- move files from .js to .mjs so they are usable as modules
- shim __dirname using fileURLToPath
- add a benchmark/README.md explaining the build process (such as it is)
- update CONTRIBUTING.md to link to the new README.md
- fix backslashes in CONTRIBUTING.md

Fixes: NaturalIntelligence#730
@srl295 srl295 force-pushed the srl295/issue730 branch from 1400529 to 03d4a5a Compare March 4, 2025 16:56
@srl295
Copy link
Contributor Author

srl295 commented Mar 4, 2025

Notes:

  • I didn't add the benchmark to Github actions, though that seems like a reasonable thing to do
  • I didn't update the benchmark/package-lock.json although the module is not usable without such an update (npm i will do this, as documented.)

@amitguptagwl amitguptagwl merged commit af4f1d2 into NaturalIntelligence:master Mar 5, 2025
7 checks passed
@coveralls
Copy link

Coverage Status

coverage: 98.946%. remained the same
when pulling 03d4a5a on srl295:srl295/issue730
into 56107fe on NaturalIntelligence:master.

1 similar comment
@coveralls
Copy link

Coverage Status

coverage: 98.946%. remained the same
when pulling 03d4a5a on srl295:srl295/issue730
into 56107fe on NaturalIntelligence:master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

benchmark uses modules, can't run as documented
3 participants