Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cogment/cogment-js-sdk

Cogment Javascript SDK

https://github.com/cogment/cogment-js-sdk

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.4%) to scientific vocabulary

Keywords

cogment javascript

Keywords from Contributors

human-in-the-loop-learning reinforcement-learning
Last synced: 6 months ago · JSON representation

Repository

Cogment Javascript SDK

Basic Info
Statistics
  • Stars: 12
  • Watchers: 1
  • Forks: 3
  • Open Issues: 12
  • Releases: 0
Topics
cogment javascript
Created about 5 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Changelog License

README.md

Cogment JS SDK

Developers

Basic setup

  1. Install dependencies:

shell script npm install

  1. Build all the sub-packages:

shell script npm run build --workspaces --if-present

  1. Run all the tests:

shell script npm run test --workspaces --if-present

Define the version of Cogment protobuf API

The version of the cogment protobuf API is defined in the ./packages/@cogment/cogment-js-sdk/config.json file at the root of the repository. It should be defined as a URL pointing to a .tar.gz archive of the cogment api, e.g. https://github.com/cogment/cogment/releases/download/v2.3.0/cogment-api.tar.gz.

To use a local version of the API copy the files in ./packages/@cogment/cogment-js-sdk/cogment/api and run npm run build:protos:compile && npm run build:webpack && npm run build:tsc instead of the default npm run build.

Release process

People having maintainers rights of the repository can follow these steps to release a version MAJOR.MINOR.PATCH. The versioning scheme follows Semantic Versioning.

  1. Run ./scripts/create_release_branch.sh MAJOR.MINOR.PATCH automatically compute and update the version of the package, create the release branch and update the changelog from the commit history,
  2. On the release branch, check and update the changelog if needed, update internal dependencies, and make sure everything's fine on CI,
  3. Run ./scripts/tag_release.sh MAJOR.MINOR.PATCH to create the specific version section in the changelog, merge the release branch in main, create the release tag and update the develop branch with those.

The rest, publishing the packages to dockerhub and updating the mirror repositories, is handled directly by the CI.

Owner

  • Name: Cogment
  • Login: cogment
  • Kind: organization

GitHub Events

Total
  • Fork event: 2
Last Year
  • Fork event: 2

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 715
  • Total Committers: 8
  • Avg Commits per committer: 89.375
  • Development Distribution Score (DDS): 0.341
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Emma Coutu e****a@c****o 471
Air-sara s****a@a****m 110
semantic-release-bot s****t@m****t 87
Clodéric Mars c****c@a****m 33
Omar H o****r@a****m 7
Emma Coutu e****a@a****m 5
Yves y****s@a****m 1
François Chabot f****s@a****m 1
Committer Domains (Top 20 + Academic)
ai-r.com: 6 martynus.net: 1 coutu.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 16
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 months
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.75
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 16
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (16)
Top Labels
Issue Labels
Pull Request Labels
dependencies (16)

Packages

  • Total packages: 1
  • Total downloads:
    • npm 18 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 2
  • Total versions: 81
  • Total maintainers: 2
npmjs.org: @cogment/cogment-js-sdk

Javascript SDK for the Cogment Framework

  • Versions: 81
  • Dependent Packages: 1
  • Dependent Repositories: 2
  • Downloads: 18 Last month
Rankings
Dependent repos count: 7.6%
Stargazers count: 9.0%
Downloads: 10.9%
Forks count: 11.6%
Average: 12.0%
Dependent packages count: 20.9%
Maintainers (2)
cloderic airedefined
Last synced: 6 months ago