cogment-doc

Cogment official website and documentation

https://github.com/cogment/cogment-doc

Science Score: 44.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary

Keywords

cogment
Last synced: 6 months ago · JSON representation ·

Repository

Cogment official website and documentation

Basic Info
  • Host: GitHub
  • Owner: cogment
  • License: apache-2.0
  • Language: JavaScript
  • Default Branch: main
  • Homepage: https://cogment.ai
  • Size: 49.2 MB
Statistics
  • Stars: 12
  • Watchers: 1
  • Forks: 4
  • Open Issues: 1
  • Releases: 0
Topics
cogment
Created about 5 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

cogment official website & documentation

Browse the website Apache 2 License

Cogment is an innovative open source AI platform designed to leverage the advent of AI to benefit humankind through human-AI collaboration developed by AI Redefined. Cogment enables AI researchers and engineers to build, train and operate AI agents in simulated or real environments shared with humans. For the full user documentation visit https://cogment.ai

This is the sources for the official website and for the documentation for the Cogment framework.

Documentation architecture

This website is built using Docusaurus 2, the styling framework is infima:

  • docusaurus.config.js is the main configuration file for the documentation.
  • ./docs contains the source for the documentation, mostly markdown file and images.
  • ./src contains the source for the other pages.

Developers

Prerequisites

  1. Have a working setup for Node 16 or above.
  2. In this directory, run npm install to install what's needed to build the doc.

Running a self reloading server

console npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

console npm run build

Formatting

This project is formatted using prettier. Most editors have support for it. The only requirement is a working Node.js environment. For further information, refer to https://prettier.io.

To run a check manually:

console npm run lint

To fix all the files automatically

console npm run task lint_fix

Owner

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

Citation (CITATION.cff)

cff-version: "1.2.0"
message: "If you use Cogment in your research, please cite the article from `preferred-citation`."
title: "Cogment User Documentation"
authors:
  - family-names: AI Redefined
    website: https://ai-r.com
license: Apache-2.0
url: https://cogment.ai
repository: https://github.com/cogment/cogment-doc
preferred-citation:
  type: "article"
  title: "Cogment: Open Source Framework For Distributed Multi-actor Training, Deployment & Operations"
  year: 2021
  url: https://arxiv.org/abs/2106.11345v1
  authors:
    - family-names: AI Redefined
      website: https://ai-r.com
    - affiliation: AI Redefined
      family-names: Gottipati
      given-names: Sai Krishna
    - affiliation: AI Redefined
      family-names: Kurandwad
      given-names: Sagar
    - affiliation: AI Redefined
      family-names: Mars
      given-names: "Clodéric"
    - affiliation: AI Redefined
      family-names: Szriftgiser
      given-names: Gregory
    - affiliation: AI Redefined
      family-names: Chabot
      given-names: "François"

GitHub Events

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

Dependencies

package-lock.json npm
  • 1136 dependencies
package.json npm
  • prettier ^2.5.1 development
  • @docusaurus/core ^2.0.0-beta.21
  • @docusaurus/preset-classic ^2.0.0-beta.21
  • @easyops-cn/docusaurus-search-local ^0.28.0
  • @fortawesome/fontawesome-svg-core ^1.3.0-beta3
  • @fortawesome/free-brands-svg-icons ^6.0.0-beta3
  • @fortawesome/free-regular-svg-icons ^6.0.0-beta3
  • @fortawesome/react-fontawesome ^0.1.17
  • @mdx-js/react ^1.6.21
  • clsx ^1.1.1
  • prism-react-renderer ^1.2.1
  • react ^17.0.1
  • react-dom ^17.0.1