Collective Knowledge framework Logo
V2.6.0

Introduction

  • CK basics
    • Project overview
    • Why CK?
    • What is CK?
    • How CK supports collaborative and reproducible ML&systems research
    • CK platform
    • CK showroom
      • CK-powered workflows, automation actions, and reusable artifacts for ML&systems R&D
  • Feedback and feature requests
  • Acknowledgments

Getting Started

  • Prerequisites
    • Linux
    • MacOS
    • Windows
    • Android (Linux host)
  • CK installation
  • Docker
  • Virtual CK environments with templates
  • Customization
  • Trying CK
    • How CK enables portable and customizable workflows
    • CK installation
    • Pull CK repositories with the universal program workflow
    • Manage CK entries
    • Invoke CK automation actions
    • Install missing packages
    • Participate in crowd-tuning
    • Use CK python API
    • Try the CK MLPerf™ workflow
    • Further information
    • Contact the CK community
  • The most common usage
    • Initialize a new CK repository in the current directory (can be existing Git repo)
    • Add dependency on other repositories to reuse automation actions and components
    • Add a new program workflow
      • Update program sources
    • Update software dependencies
    • Reuse or add basic datasets
    • Add new CK software detection plugins
    • Add new CK packages
    • Pack CK repository
    • Prepare CK repository for Digital Libraries
    • Prepare a Docker container with CK workflows
    • Create more complex workflows
      • Using shell scripts
      • Using CK modules
    • Generate reproducible and interactive articles
    • Publish CK repositories, workflows, and components
    • Contact the CK community

User guide

  • CK CLI and API
    • CLI to manage CK repositories
      • Init new CK repository in the current path
      • Pull existing repository using Git URL
      • Pull existing repository from cTuning GitHub
      • Download a repository as a zip file
      • Update all local CK repositories from Git
      • Create a dummy CK repository locally
      • Import existing local repository from current directory
      • Import existing local repository from some local directory
      • List local CK repositories
      • Delete a given CK repository
      • Find a path to a given CK repository
      • Pack a given CK repository to a zip file
      • Add CK entries from a zip file to an existing CK repository
    • CLI to manage CK entries
      • List CK modules from all local CK repositories
      • List some CK modules with a wildcard from all local CK repositories
      • List CK entries for a given CK module in a given repository
      • Search for CK entries by tags
      • Search for CK entries by a string
      • Find a path to a given CK entry
      • Show JSON meta description of a given entry
      • Delete a given CK entry
      • Create an empty CK entry
      • Rename a given CK entry
      • Move a given CK entry to another CK repository
      • Copy a given CK entry
    • CLI to manage CK actions
    • CK Python API
    • More resources
  • CK specs
    • CK repository
      • Root files
      • Root directories (CK modules)
      • Sub-directories for CK entries
      • CK entry
  • Automating ML&systems R&D
    • Platform and environment detection
    • Software detection
    • Virtual environment
    • Meta packages
    • Scripts
    • Portable program pipeline (workflow)
    • Reproducible experiments
    • Dashboards
    • Interactive articles
    • Jupyter notebooks
    • Docker
  • Further info
  • Notes
  • How to contribute

Resources

  • Auto-generated CK Python API
    • Submodules
    • ck.kernel module
    • ck.files module
    • ck.net module
    • ck.strings module
    • Module contents
  • Miscellaneous
Collective Knowledge framework
  • Docs »
  • Miscellaneous
  • Edit on GitHub

Miscellaneous¶

  • CK Wiki
  • cKnowledge.io docs
Previous

© Copyright 2015-2020 Grigori Fursin and the cTuning foundation Revision 0dafd7cd.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: V2.6.0
Versions
latest
stable
v2.6.0
v2.5.8
v2.5.7
v2.5.3
v2.5.0
v2.0.10
v2.0.9
v2.0.8
v2.0.7
v2.0.1
v1.50.0
v1.17.0
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by Read the Docs.