Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
beat
beat.core
Commits
6a05f6b5
Commit
6a05f6b5
authored
May 29, 2018
by
Samuel GAIST
Browse files
[doc] Added header to all modules
parent
72ae9448
Changes
26
Hide whitespace changes
Inline
Side-by-side
beat/core/algorithm.py
View file @
6a05f6b5
...
...
@@ -26,7 +26,13 @@
###############################################################################
"""Validation for algorithms"""
"""
=========
algorithm
=========
Validation for algorithms
"""
import
os
import
sys
...
...
beat/core/baseformat.py
View file @
6a05f6b5
...
...
@@ -25,5 +25,12 @@
# #
###############################################################################
"""
==========
baseformat
==========
Coming directly from beat.backend.python
"""
from
beat.backend.python.baseformat
import
*
beat/core/data.py
View file @
6a05f6b5
...
...
@@ -25,6 +25,13 @@
# #
###############################################################################
"""
====
data
====
Coming directly from beat.backend.python
"""
from
beat.backend.python.data
import
mixDataIndices
from
beat.backend.python.data
import
getAllFilenames
...
...
beat/core/data_loaders.py
View file @
6a05f6b5
...
...
@@ -25,6 +25,14 @@
# #
###############################################################################
"""
============
data_loaders
============
Coming directly from beat.backend.python
"""
from
beat.backend.python.data_loaders
import
DataLoaderList
from
beat.backend.python.data_loaders
import
DataLoader
...
...
beat/core/database.py
View file @
6a05f6b5
...
...
@@ -26,7 +26,13 @@
###############################################################################
"""Validation of databases"""
"""
========
database
========
Validation of databases
"""
import
os
import
sys
...
...
beat/core/dataformat.py
View file @
6a05f6b5
...
...
@@ -26,7 +26,13 @@
###############################################################################
"""Validation and parsing for dataformats"""
"""
==========
dataformat
==========
Validation and parsing for dataformats
"""
import
os
import
copy
...
...
beat/core/dock.py
View file @
6a05f6b5
...
...
@@ -25,6 +25,14 @@
# #
###############################################################################
"""
====
dock
====
Docker helper classes
"""
import
os
import
six
...
...
beat/core/drawing.py
View file @
6a05f6b5
...
...
@@ -25,8 +25,14 @@
# #
###############################################################################
"""
=======
drawing
=======
Utilities for drawing toolchains and experiments
"""
'''Utilities for drawing toolchains and experiments'''
def
text_color
(
c
):
'''Calculates if text must be black/white for a given color background
...
...
beat/core/environments.py
View file @
6a05f6b5
...
...
@@ -26,6 +26,10 @@
###############################################################################
"""
===========
environment
===========
Helper functions related to environment management
"""
...
...
beat/core/execution/base.py
View file @
6a05f6b5
...
...
@@ -26,7 +26,15 @@
###############################################################################
'''Execution utilities'''
"""
====
base
====
Execution utilities
"""
import
os
import
sys
...
...
beat/core/execution/docker.py
View file @
6a05f6b5
...
...
@@ -25,8 +25,13 @@
# #
###############################################################################
"""
======
docker
======
'''Execution utilities'''
Execution utilities
"""
import
os
import
requests
...
...
beat/core/execution/local.py
View file @
6a05f6b5
...
...
@@ -25,8 +25,14 @@
# #
###############################################################################
"""
=====
local
=====
Execution utilities
"""
'''Execution utilities'''
import
os
import
sys
...
...
beat/core/execution/remote.py
View file @
6a05f6b5
...
...
@@ -26,7 +26,13 @@
###############################################################################
'''Execution utilities'''
"""
==========
remote
==========
Execution utilities
"""
import
zmq
...
...
beat/core/execution/subprocess.py
View file @
6a05f6b5
...
...
@@ -26,7 +26,13 @@
###############################################################################
'''Execution utilities'''
"""
==========
subprocess
==========
Execution utilities
"""
from
__future__
import
absolute_import
...
...
beat/core/experiment.py
View file @
6a05f6b5
...
...
@@ -26,7 +26,13 @@
###############################################################################
"""Validation for experiments"""
"""
==========
experiment
==========
Validation for experiments
"""
import
os
import
collections
...
...
beat/core/hash.py
View file @
6a05f6b5
...
...
@@ -26,7 +26,13 @@
###############################################################################
"""Various functions for hashing platform contributions and others"""
"""
====
hash
====
Various functions for hashing platform contributions and others
"""
import
os
...
...
@@ -42,7 +48,7 @@ from beat.backend.python.hash import _stringify
from
beat.backend.python.hash
import
_compact
#----------------------------------------------------------
#
----------------------------------------------------------
def
hashBlockOutput
(
block_name
,
algorithm_name
,
algorithm_hash
,
...
...
@@ -61,7 +67,7 @@ def hashBlockOutput(block_name, algorithm_name, algorithm_hash,
return
hash
(
s
)
#----------------------------------------------------------
#
----------------------------------------------------------
def
hashAnalyzer
(
analyzer_name
,
algorithm_name
,
algorithm_hash
,
...
...
@@ -79,7 +85,7 @@ def hashAnalyzer(analyzer_name, algorithm_name, algorithm_hash,
return
hash
(
s
)
#----------------------------------------------------------
#
----------------------------------------------------------
def
hashJSONStr
(
contents
,
description
):
...
...
beat/core/inputs.py
View file @
6a05f6b5
...
...
@@ -25,6 +25,14 @@
# #
###############################################################################
"""
======
inputs
======
Coming directly from beat.backend.python
"""
from
beat.backend.python.inputs
import
InputList
from
beat.backend.python.inputs
import
Input
...
...
beat/core/library.py
View file @
6a05f6b5
...
...
@@ -26,7 +26,13 @@
###############################################################################
"""Validation for libraries"""
"""
=======
library
=======
Validation for libraries
"""
import
os
...
...
@@ -43,7 +49,6 @@ from beat.backend.python.library import Storage
from
beat.backend.python.library
import
Library
as
BackendLibrary
class
Library
(
BackendLibrary
):
"""Librarys represent independent algorithm components within the platform.
...
...
beat/core/loader.py
View file @
6a05f6b5
...
...
@@ -25,5 +25,13 @@
# #
###############################################################################
"""
======
loader
======
Coming directly from beat.backend.python
"""
from
beat.backend.python.loader
import
*
beat/core/message_handler.py
View file @
6a05f6b5
...
...
@@ -25,5 +25,13 @@
# #
###############################################################################
"""
===============
message_handler
===============
Coming directly from beat.backend.python
"""
from
beat.backend.python.message_handler
import
MessageHandler
Prev
1
2
Next
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment