Skip to content

Commit

Permalink
moving most readme and docs to Sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
@gfursin
gfursin committed Aug 20, 2020
1 parent 0de2894 commit efa2e6c
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 171 deletions.
127 changes: 12 additions & 115 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@ References: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3865242.svg)](ht

## Overview

Collective Knowledge framework (CK) provides a common API with reusable
automation actions to all software projects together with a database-like
control for their individual components including algorithms, packages,
data sets, models, and results. The goal is to make it easier for
researchers and practitioners to reuse best R&D practices and artifacts,
Collective Knowledge framework (CK) provides a common API to all software projects
together with a database-like control and reusable automation actions
for their individual components (algorithms, packages,
data sets, models, scripts, results, and so on).
The goal is to make it easier for researchers and practitioners
to reuse best R&D practices and artifacts,
assemble portable workflows, reproduce and compare research techniques,
build upon them, and use them in production.
See [some real-world use cases](https://cKnowledge.org/partners.html)
Expand Down Expand Up @@ -51,98 +52,10 @@ from Arm, General Motors, IBM, MLPerf, RPi, and ACM.
to accelerate the development and adoption of innovative technology -
get in touch with [Grigori Fursin](https://cKnowledge.io/@gfursin) (CK author and project leader) to know more!*

## Concept

**You can read about our motivation to create CK at [cKnowledge.org](https://cKnowledge.org)**

We have developed the Collective Knowledge framework (CK) to help our colleagues, students, researchers and practitioners
share their projects and artifacts (code, data, models, scripts, experiments, papers)
as a human-readable database ([CK repository]( https://cKnowledge.io/repos ))
with unified API, CLI, JSON input/output/meta descriptions
and [reusable automation actions](https://cKnowledge.io/actions).

For example, CK features
[software detection plugins](https://cKnowledge.io/soft),
[meta packages](https://cKnowledge.io/packages)
and [OS descriptions](https://cKnowledge.io/c/os)
to automate the detection and installation of [all the dependencies](https://cknowledge.io/c/solution/mlperf-inference-v0.5-detection-openvino-ssd-mobilenet-coco-500-linux/#dependencies)
including data sets and models required by a given research project to run on any target platform.

Such CK actions and components can be connected into platform-agnostic,
portable, customizable and reproducible [program pipelines](https://cKnowledge.io/programs)
and [functional solutions](https://cKnowledge.io/solutions)
that can be used with Continuous Integration tools,
existing/legacy projects, and production systems.

The stable components, portable workflows and solutions are published along
with [reproduced papers](https://cKnowledge.io/reproduced-papers)
at the [open Collective Knowledge platform](https://cKnowledge.io).
They provide a unified way to benchmark, optimize, test and co-design
software and hardware for emerging technoligies (AI, ML, quantum, IoT)
across diverse hardware, datasets and models using [public scoreboards](https://cKnowledge.io/results)

Our long-term goal is to enable collaborative, reproducible, sustainable and production-ready deep tech research (AI, ML, quantum, IoT).
See the [real CK use cases from our partners](https://cKnowledge.org/partners.html)
and try our [MLPerf automation demo](https://cKnowledge.io/demo) on your platform.

You can learn more about our project in the [online documentation](https://cKnowledge.io/docs)
and the following presentations and white papers:
[2020]( https://arxiv.org/abs/2006.07161 ),
[2019]( https://doi.org/10.5281/zenodo.2556147 ),
[2018]( https://cknowledge.io/c/report/rpi3-crowd-tuning-2017-interactive ),
[2017]( https://www.slideshare.net/GrigoriFursin/enabling-open-and-reproducible-computer-systems-research-the-good-the-bad-and-the-ugly ),
[2009]( https://hal.inria.fr/inria-00436029v2 ).

*Even though the CK technology is used [in production](https://cKnowledge.org/partners.html) for more than 5 years, it is still a proof-of-concept prototype requiring further improvements and standardization. Depending on the available resources, we plan to develop a new, backward-compatible and more user-friendly version - please [get in touch](https://cKnowledge.org/contacts.html) if you are interested to know more!*


## Open CK portal

* [cKnowledge.io](https://cKnowledge.io): the open portal with stable CK components, workflows, reproduced papers, and SOTA scoreboards for complex computational systems (AI,ML,quantum,IoT):
* [Browse SOTA scoreboards powered by CK workflows](https://cKnowledge.io/reproduced-results)
* [Browse all shared CK components](https://cKnowledge.io/browse)
* [Search for reusable CK components](https://cKnowledge.io)
* [Our reproducibility initiatives for systems and ML conferences](https://cTuning.org/ae)




## CK use cases

* [Real world use cases from our industrial and academic partners](https://cKnowledge.org/partners.html)
* [MLPerf CK workflow (development version)](https://github.com/ctuning/ck-mlperf)
* [MLPerf stable crowd-benchmarking demo with the live scoreboard](https://cKnowledge.io/test)
* [CK-based live research paper (collaboration with the Raspberry Pi foundation)](https://cKnowledge.io/report/rpi3-crowd-tuning-2017-interactive).

[<img src="https://img.youtube.com/vi/DIkZxraTmGM/0.jpg" width="320">](https://www.youtube.com/watch?v=DIkZxraTmGM)
[<img src="https://img.youtube.com/vi/VpedDdia5yY/0.jpg" width="320">](https://www.youtube.com/watch?v=VpedDdia5yY)







## Documentation

* [Online CK documentation](https://cKnowledge.io/docs)

Older wiki-based documentation (we gradually move it to the above Sphinx-based documentation):

* [CK wiki](https://github.com/ctuning/ck/wiki)
* [CK basics](https://michel.steuwer.info/About-CK)
* [CK Getting Started Guide](https://github.com/ctuning/ck/wiki/First-steps)
* [Contributing to CK](https://github.com/ctuning/ck/wiki/Adding-new-workflows)



## Installation

Follow [this guide](https://cKnowledge.io/docs/getting-started/ck-installation.html)
to install the CK SDK on your platform.

Check [CK-based demo](https://cKnowledge.io/demo) to participate in reproducible MLPerf benchmarking
with a [public SOTA scoreboard](https://cknowledge.io/c/result/sota-mlperf-object-detection-v0.5-crowd-benchmarking).
Follow [this guide](https://ck.readthedocs.io/en/latest/getting-started/installation.html)
to install CK framework on your platform.

CK supports the following platforms:

Expand All @@ -156,26 +69,10 @@ CK supports the following platforms:
| Android | ± | ✓ |
| iOS | TBD | TBD |

## Documentation

* [Online CK documentation](https://ck.readthedocs.io)


## Get involved

* This is an ongoing community project and there is a lot to be improved -
don't hesitate to [get in touch](https://cKnowledge.org/contacts.html)
using our slack, mailing list, twitter and email
if you have any feedback or would like to collaborate.

* Check this [outdated guide](https://github.com/ctuning/ck/wiki) to add your workflows and components.
We are gradually rewriting [this guide](https://cKnowledge.io/docs) with our limited resources
and developing [cBench](https://github.com/cknowledge/cbench) to simplify
the user experience and provide a CK GUI at the [open cKnowledge.io platform](https://cKnowledge.io).



## Acknowledgments

We would like to thank all [CK users and partners](https://cKnowledge.org/partners.html)
for fruitful discussions and feedback!

*Copyright 2015-2020 [Grigori Fursin](https://cKnowledge.io/@gfursin) ([cTuning foundation](https://cTuning.org) and [cKnowledge consulting SAS](https://www.linkedin.com/company/cknowledge))*
* [CK Basics](https://michel-steuwer.github.io/About-CK)
* [Older Wiki](https://github.com/ctuning/ck/wiki)
14 changes: 14 additions & 0 deletions docs/getting-started/installation.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Supported platforms

CK supports the following platforms:

| | As a host platform | As a target platform |
|---------------|:------------------:|:--------------------:|
| Generic Linux | ✓ | ✓ |
| Linux (Arm) | ✓ | ✓ |
| Raspberry Pi | ✓ | ✓ |
| MacOS | ✓ | ± |
| Windows | ✓ | ✓ |
| Android | ± | ✓ |
| iOS | TBD | TBD |

# CK framework installation

You can install the Collective Knowledge framework on most platforms using PIP as follows:
Expand Down
11 changes: 6 additions & 5 deletions docs/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ CK framework documentation

.. epigraph::

Collective Knowledge framework (CK) provides a common API with reusable
automation actions to all software projects together with a database-like
control for their individual components including algorithms, packages,
data sets, models, and results. The goal is to make it easier for
researchers and practitioners to reuse best R&D practices and artifacts,
Collective Knowledge framework (CK) provides a common API to all software projects
together with a database-like control and reusable automation actions
for their individual components (algorithms, packages,
data sets, models, scripts, results, and so on).
The goal is to make it easier for researchers and practitioners
to reuse best R&D practices and artifacts,
assemble portable workflows, reproduce and compare research techniques,
build upon them, and use them in production. See some real-world use cases
from Arm, General Motors, IBM, MLPerf, RPi, and ACM at https://cKnowledge.org/partners.html.
Expand Down
51 changes: 0 additions & 51 deletions docs/intro/introduction.md
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,5 @@
# Collective Knowledge framework (CK)

[![Downloads](https://pepy.tech/badge/ck)](https://pepy.tech/project/ck)
[![PyPI version](https://badge.fury.io/py/ck.svg)](https://badge.fury.io/py/ck)
[![Python Version](https://img.shields.io/badge/python-2.7%20|%203.4+-blue.svg)](https://pypi.org/project/ck)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)

Linux/MacOS: [![Build Status](https://travis-ci.org/ctuning/ck.svg?branch=master)](https://travis-ci.org/ctuning/ck)
Windows: [![Windows Build status](https://ci.appveyor.com/api/projects/status/iw2k4eajy54xrvqc?svg=true)](https://ci.appveyor.com/project/gfursin/ck)
Coverage: [![Coverage Status](https://coveralls.io/repos/github/ctuning/ck/badge.svg)](https://coveralls.io/github/ctuning/ck)

References: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3865242.svg)](https://doi.org/10.5281/zenodo.3865242)
[![arXiv](https://img.shields.io/badge/arXiv-2006.07161-00ff00.svg)](https://arxiv.org/abs/2006.07161)

## News

* **2020 August**: We are very excited to announce that we have completed
Expand Down Expand Up @@ -113,48 +101,9 @@ and the following presentations and white papers:

## Documentation

* [Online CK documentation](https://cKnowledge.io/docs)

Older wiki-based documentation (we gradually move it to the above Sphinx-based documentation):

* [CK wiki](https://github.com/ctuning/ck/wiki)
* [CK basics](https://michel.steuwer.info/About-CK)
* [CK Getting Started Guide](https://github.com/ctuning/ck/wiki/First-steps)
* [Contributing to CK](https://github.com/ctuning/ck/wiki/Adding-new-workflows)



## Installation

Follow [this guide](https://cKnowledge.io/docs/getting-started/ck-installation.html)
to install the CK SDK on your platform.

Check [CK-based demo](https://cKnowledge.io/demo) to participate in reproducible MLPerf benchmarking
with a [public SOTA scoreboard](https://cknowledge.io/c/result/sota-mlperf-object-detection-v0.5-crowd-benchmarking).

CK supports the following platforms:

| | As a host platform | As a target platform |
|---------------|:------------------:|:--------------------:|
| Generic Linux | ✓ | ✓ |
| Linux (Arm) | ✓ | ✓ |
| Raspberry Pi | ✓ | ✓ |
| MacOS | ✓ | ± |
| Windows | ✓ | ✓ |
| Android | ± | ✓ |
| iOS | TBD | TBD |




## Get involved

* This is an ongoing community project and there is a lot to be improved -
don't hesitate to [get in touch](https://cKnowledge.org/contacts.html)
using our slack, mailing list, twitter and email
if you have any feedback or would like to collaborate.

* Check this [outdated guide](https://github.com/ctuning/ck/wiki) to add your workflows and components.
We are gradually rewriting [this guide](https://cKnowledge.io/docs) with our limited resources
and developing [cBench](https://github.com/cknowledge/cbench) to simplify
the user experience and provide a CK GUI at the [open cKnowledge.io platform](https://cKnowledge.io).

0 comments on commit efa2e6c

Please sign in to comment.