softmax - npm Package Compare versions
Comparing version 2.0.4 to 2.0.5
@@ -9,3 +9,2 @@ function wrap(func) { | ||
| module.exports = wrap; |
| { | ||
| "name": "softmax", | ||
| "description": "A softmax multi-armed bandit algorithm", | ||
| "version": "2.0.4", | ||
| "version": "2.0.5", | ||
| "license": "ISC", | ||
@@ -6,0 +6,0 @@ "main": "index.js", |
@@ -123,3 +123,2 @@ softmax | ||
| ### `Algorithm#reward(arm, reward)` | ||
@@ -131,4 +130,4 @@ | ||
| - `arm` (Integer): the arm index (provided from `algorithm.select()`) | ||
| - `reward` (Number): the observed reward value (which can be 0, to indicate no reward) | ||
| - `arm` (`Number`, Integer): the arm index (provided from `Algorithm#select()`) | ||
| - `reward` (`Number`): the observed reward value (which can be 0 to indicate no reward) | ||
@@ -172,2 +171,20 @@ #### Returns | ||
| ### Contribute | ||
| PRs are welcome! For bugs, please include a failing test which passes when your PR is applied. [Travis CI](https://travis-ci.org/kurttheviking/softmax-js) provides on-demand testing for commits and pull requests. | ||
| ### Workflow | ||
| 1. Feature development and bug fixing should occur on a non-master branch. | ||
| 2. Changes should be submitted to master via a [Pull Request](https://github.com/kurttheviking/softmax-js/compare). | ||
| 3. Pull Requests should be merged via a merge commit. Local "in-process" commits may be squashed prior to pushing to the remote feature branch. | ||
| To enable a git hook that runs `npm test` prior to pushing, `cd` into the local repo and run: | ||
| ```sh | ||
| touch .git/hooks/pre-push | ||
| chmod +x .git/hooks/pre-push | ||
| echo "npm test" > .git/hooks/pre-push | ||
| ``` | ||
| ### Tests | ||
@@ -188,5 +205,1 @@ | ||
| **Note:** Tests against stochastic methods (e.g. `Algorithm#select`) are inherently tricky to test with deterministic assertions. The approach here is to iterate across a semi-random set of conditions to verify that each run produces valid output. As a result, each test suite run encounters slightly different execution state. In the future, the test suite should be expanded to include a more robust test of the distribution's properties – though because of the number of runs required, should be triggered with an optional flag. | ||
| ### Contribute | ||
| PRs are welcome! For bugs, please include a failing test which passes when your PR is applied. [Travis CI](https://travis-ci.org/kurttheviking/softmax-js) provides on-demand testing for commits and pull requests. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by4.61%
12661
- Number of lines in readme file
- increased by6.88%
202
No dependency changes