Skip to content

Commit

Permalink
first prototype
Browse files Browse the repository at this point in the history
  • Loading branch information
gfursin committed Mar 28, 2022
1 parent c7918ad commit 3c146cb
Show file tree
Hide file tree
Showing 36 changed files with 3,442 additions and 5 deletions.
141 changes: 141 additions & 0 deletions ck2/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
# Misc
build
build/*
MANIFEST
*.pyc
*tmp/
__pycache__
.cache/
.coverage
htmlcov


# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/
12 changes: 12 additions & 0 deletions ck2/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Contributing to CM (CK2)

* Pull requests: TBA
* Issues: TBA
* Mailing list: TBA
* Discord channel: TBA
* Slack channel: TBA

# Contributors

* Grigori Fursin, OctoML
* Thierry Moreau, OctoML
128 changes: 128 additions & 0 deletions ck2/LICENSE.CK
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
MLCOMMONS ASSOCIATION LICENSE

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

This license reproduces without alteration the terms of the Apache License

Version 2.0, January 2004

http://www.apache.org/licenses/

1. Definitions.
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is
granting the License.
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are
controlled by, or are under common control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the direction or management of such
entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this
License.
"Source" form shall mean the preferred form for making modifications, including but not limited to
software source code, documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical transformation or translation of a
Source form, including but not limited to compiled object code, generated documentation, and
conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or Object form, made available under
the License, as indicated by a copyright notice that is included in or attached to the work (an example
is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or
derived from) the Work and for which the editorial revisions, annotations, elaborations, or other
modifications represent, as a whole, an original work of authorship. For the purposes of this License,
Derivative Works shall not include works that remain separable from, or merely link (or bind by
name) to the interfaces of, the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including the original version of the Work and
any modifications or additions to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal
Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition,
"submitted" means any form of electronic, verbal, or written communication sent to the Licensor or
its representatives, including but not limited to communication on electronic mailing lists, source
code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor
for the purpose of discussing and improving the Work, but excluding communication that is
conspicuously marked or otherwise designated in writing by the copyright owner as "Not a
Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
Contribution has been received by Licensor and subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of this License, each
Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
1106217.1
irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly
perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor
hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made, use, offer to sell, sell, import,
and otherwise transfer the Work, where such license applies only to those patent claims licensable by
such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of
their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute
patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging
that the Work or a Contribution incorporated within the Work constitutes direct or contributory
patent infringement, then any patent licenses granted to You under this License for that Work shall
terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works
thereof in any medium, with or without modifications, and in Source or Object form, provided that
You meet the following conditions:
1. You must give any other recipients of the Work or Derivative Works a copy of this License;
and
2. You must cause any modified files to carry prominent notices stating that You changed the
files; and
3. You must retain, in the Source form of any Derivative Works that You distribute, all
copyright, patent, trademark, and attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of the Derivative Works; and
4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative
Works that You distribute must include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not pertain to any part of the
Derivative Works, in at least one of the following places: within a NOTICE text file
distributed as part of the Derivative Works; within the Source form or documentation, if
provided along with the Derivative Works; or, within a display generated by the Derivative
Works, if and wherever such third-party notices normally appear. The contents of the
NOTICE file are for informational purposes only and do not modify the License. You may
add Your own attribution notices within Derivative Works that You distribute, alongside or
as an addendum to the NOTICE text from the Work, provided that such additional
attribution notices cannot be construed as modifying the License.
You may add Your own copyright statement to Your modifications and may provide
additional or different license terms and conditions for use, reproduction, or distribution of
Your modifications, or for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with the conditions stated in
this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution
intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms
and conditions of this License, without any additional terms or conditions. Notwithstanding the
above, nothing herein shall supersede or modify the terms of any separate license agreement you
may have executed with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade names, trademarks,
service marks, or product names of the Licensor, except as required for reasonable and customary
use in describing the origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor
provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including,
without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
determining the appropriateness of using or redistributing the Work and assume any risks associated
with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including
negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including
any direct, indirect, special, incidental, or consequential damages of any character arising as a result
of this License or out of the use or inability to use the Work (including but not limited to damages for
loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative
Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty,
indemnity, or other liability obligations and/or rights consistent with this License. However, in
accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not
on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each
Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by
reason of your accepting any such warranty or additional liability.
10 changes: 5 additions & 5 deletions ck2/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Collective Mind framework aka as CK2 or CM
# Collective Mind automation framework (CM or CK2)

*Following the success of the [Collective Knowledge framework (CK)](https://github.com/mlcommons/ck)
*Following the success of the [Collective Knowledge automation framework (CK)](https://github.com/mlcommons/ck)
to automate [MLPerf benchmark](https://github.com/mlcommons/ck/tree/master/docs/mlperf-automation),
simplify the deployment of optimized AI/ML systems [in production](https://cKnowledge.org/partners.html)
and enable [reproducible experiments](https://cTuning.org/ae),
Expand Down Expand Up @@ -35,7 +35,7 @@ scientific experimentation, FAIR principles, and best practices for reproducible

# Related community events

* **2022 April:** HPCA'22 reproducibility talk
* **2022 April 3:** HPCA'22 talk about using CK/CK2 to automate MLPerf design space exploration and deploy efficient AI/ML Systems
* **2022 March:** Presentation about our experience connecting MLOps and DevOps


Expand All @@ -46,10 +46,10 @@ scientific experimentation, FAIR principles, and best practices for reproducible

# Feedback

The CM framework is being developed with the community and based on the community feedback!
The CM framework (CK2) is being developed with the community and based on the community feedback!
Please don't hesitate to get in touch with us if you have any suggestions about how to
bridge the growing gap between scientific research and production.
Please report encountered issues [here](https://github.com/octoml/cm/issues).
Please report encountered issues [here](https://github.com/mlcommons/ck/issues).

# Coordinators

Expand Down
6 changes: 6 additions & 0 deletions ck2/cmind/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
__version__ = "0.5.1"

from cmind.kernel import access
from cmind.kernel import error
from cmind.kernel import halt
from cmind.kernel import CM
57 changes: 57 additions & 0 deletions ck2/cmind/artifact.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Collective Mind artifact

import os

from cmind import utils

class Artifact:
############################################################
def __init__(self, cmind, path):
"""
Initialize artifact class
"""

self.cmind = cmind

self.cfg = cmind.cfg

self.path = path
self.meta = {}

############################################################
def load(self, ignore_inheritance = False, base_recursion = 0):
"""
Load artifact
"""

path_artifact_meta = os.path.join(self.path, self.cfg['file_cmeta'])

r = utils.is_file_json_or_yaml(path_artifact_meta)
if r['return'] >0 : return r

if not r['is_file']:
return {'return':16, 'error': 'CM artifact not found in path {}'.format(self.path)}

# Search if there is a repo in this path
r = utils.load_yaml_and_json(file_name_without_ext = path_artifact_meta)
if r['return'] >0: return r

meta = r['meta']

if not ignore_inheritance:
automation_uid = meta.get('automation_uid', '')
automation_alias = meta.get('automation_alias', '')
automation = automation_alias
if automation_uid!='': automation+=','+automation_uid

# Check inheritance
r = utils.process_meta_for_inheritance({'automation':automation,
'meta':meta,
'cmind':self.cmind,
'base_recursion':base_recursion})
if r['return']>0: return r

self.meta = r['meta']

return {'return':0}
Loading

0 comments on commit 3c146cb

Please sign in to comment.