Collective Knowledge framework
V2.5.3
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
CK installation
Prerequisites
Linux
MacOS
Windows
Android (Linux host)
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
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Z
A
access() (in module ck.kernel)
access_ck_api() (in module ck.net)
access_index_server() (in module ck.kernel)
add() (in module ck.kernel)
add_action() (in module ck.kernel)
add_index() (in module ck.kernel)
B
browser() (in module ck.kernel)
C
cd() (in module ck.kernel)
cdc() (in module ck.kernel)
check_lock() (in module ck.kernel)
check_version() (in module ck.kernel)
check_writing() (in module ck.kernel)
cid() (in module ck.kernel)
ck (module)
ck.files (module)
ck.kernel (module)
ck.net (module)
ck.strings (module)
cli() (in module ck.kernel)
compare_dicts() (in module ck.kernel)
compare_flat_dicts() (in module ck.kernel)
convert_ck_list_to_dict() (in module ck.kernel)
convert_cm_to_ck() (in module ck.kernel)
convert_entry_to_cid() (in module ck.kernel)
convert_file_to_upload_string() (in module ck.kernel)
convert_iso_time() (in module ck.kernel)
convert_json_str_to_dict() (in module ck.kernel)
(in module ck.strings)
convert_str_key_to_int() (in module ck.kernel)
convert_str_tags_to_list() (in module ck.kernel)
convert_upload_string_to_file() (in module ck.kernel)
copy() (in module ck.kernel)
copy_path_to_clipboard() (in module ck.kernel)
copy_to_clipboard() (in module ck.kernel)
(in module ck.strings)
cp() (in module ck.kernel)
create_entry() (in module ck.kernel)
D
debug_out() (in module ck.kernel)
delete() (in module ck.kernel)
delete_alias() (in module ck.kernel)
delete_directory() (in module ck.kernel)
delete_file() (in module ck.kernel)
delete_index() (in module ck.kernel)
detect_cid_in_current_path() (in module ck.kernel)
download() (in module ck.kernel)
dump_json() (in module ck.kernel)
(in module ck.strings)
dumps_json() (in module ck.kernel)
E
edit() (in module ck.kernel)
eout() (in module ck.kernel)
err() (in module ck.kernel)
F
filter_add_index() (in module ck.kernel)
filter_convert_cm_to_ck() (in module ck.kernel)
filter_delete_index() (in module ck.kernel)
find() (in module ck.kernel)
find2() (in module ck.kernel)
find_path_to_data() (in module ck.kernel)
find_path_to_entry() (in module ck.kernel)
find_path_to_repo() (in module ck.kernel)
find_repo_by_path() (in module ck.kernel)
find_string_in_dict_or_list() (in module ck.kernel)
flatten_dict() (in module ck.kernel)
flatten_dict_internal() (in module ck.kernel)
flatten_dict_internal_check_key() (in module ck.kernel)
G
gen_tmp_file() (in module ck.kernel)
gen_uid() (in module ck.kernel)
get_api() (in module ck.kernel)
get_by_flat_key() (in module ck.kernel)
get_current_date_time() (in module ck.kernel)
get_default_repo() (in module ck.kernel)
get_from_dicts() (in module ck.kernel)
get_os_ck() (in module ck.kernel)
get_split_dir_number() (in module ck.kernel)
get_version() (in module ck.kernel)
guide() (in module ck.kernel)
H
help() (in module ck.kernel)
I
index_module() (in module ck.kernel)
info() (in module ck.kernel)
init() (in module ck.kernel)
inp() (in module ck.kernel)
input_json() (in module ck.kernel)
is_uid() (in module ck.kernel)
is_uoa() (in module ck.kernel)
J
jerr() (in module ck.kernel)
L
list_actions() (in module ck.kernel)
list_all_files() (in module ck.kernel)
list_data() (in module ck.kernel)
list_data2() (in module ck.kernel)
list_files() (in module ck.kernel)
list_tags() (in module ck.kernel)
load() (in module ck.kernel)
load_json_file() (in module ck.files)
(in module ck.kernel)
load_meta_from_path() (in module ck.kernel)
load_module_from_path() (in module ck.kernel)
load_repo_info_from_cache() (in module ck.kernel)
load_text_file() (in module ck.files)
(in module ck.kernel)
load_yaml_file() (in module ck.files)
(in module ck.kernel)
lower_list() (in module ck.kernel)
M
merge_dicts() (in module ck.kernel)
move() (in module ck.kernel)
mv() (in module ck.kernel)
O
out() (in module ck.kernel)
P
parse_cid() (in module ck.kernel)
path() (in module ck.kernel)
perform_action() (in module ck.kernel)
perform_remote_action() (in module ck.kernel)
prepare_special_info_about_entry() (in module ck.kernel)
print_input() (in module ck.kernel)
process_meta_for_inheritance() (in module ck.kernel)
pull() (in module ck.kernel)
push() (in module ck.kernel)
pwiki() (in module ck.kernel)
python_version() (in module ck.kernel)
R
reinit() (in module ck.kernel)
reload_repo_cache() (in module ck.kernel)
remove() (in module ck.kernel)
remove_action() (in module ck.kernel)
ren() (in module ck.kernel)
rename() (in module ck.kernel)
request() (in module ck.net)
restore_flattened_dict() (in module ck.kernel)
restore_state() (in module ck.kernel)
rm() (in module ck.kernel)
rm_read_only() (in module ck.kernel)
run_and_get_stdout() (in module ck.kernel)
S
safe_float() (in module ck.kernel)
safe_get_val_from_list() (in module ck.kernel)
safe_int() (in module ck.kernel)
save_json_to_file() (in module ck.files)
(in module ck.kernel)
save_repo_cache() (in module ck.kernel)
save_state() (in module ck.kernel)
save_text_file() (in module ck.files)
(in module ck.kernel)
save_yaml_to_file() (in module ck.files)
(in module ck.kernel)
search() (in module ck.kernel)
search2() (in module ck.kernel)
search_filter() (in module ck.kernel)
search_string_filter() (in module ck.kernel)
select() (in module ck.kernel)
select_uoa() (in module ck.kernel)
set_by_flat_key() (in module ck.kernel)
set_lock() (in module ck.kernel)
short_help() (in module ck.kernel)
split_name() (in module ck.kernel)
status() (in module ck.kernel)
substitute_str_in_file() (in module ck.kernel)
system_with_timeout() (in module ck.kernel)
system_with_timeout_kill() (in module ck.kernel)
T
tested() (in module ck.kernel)
U
uid() (in module ck.kernel)
unzip_file() (in module ck.kernel)
update() (in module ck.kernel)
V
version() (in module ck.kernel)
W
webapi() (in module ck.kernel)
webhelp() (in module ck.kernel)
wiki() (in module ck.kernel)
Z
zip() (in module ck.kernel)
Read the Docs
v: V2.5.3
Versions
latest
stable
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
.