Skip to main content

_protocol

TOC​

Attributes​

🅰 VERSION​

VERSION = version("neetbox") #You can add error handling if needed

🅰 ID_KEY​

ID_KEY = """id"""

🅰 NAME_KEY​

NAME_KEY = """name"""

🅰 ARGS_KEY​

ARGS_KEY = """args"""

🅰 MACHINE_ID_KEY​

MACHINE_ID_KEY = """machineId"""

🅰 PROJECT_KEY​

PROJECT_KEY = """project"""

🅰 SERVER_KEY​

SERVER_KEY = """server"""

🅰 PROJECT_ID_KEY​

PROJECT_ID_KEY = """projectId"""

🅰 RUN_ID_KEY​

RUN_ID_KEY = """runId"""

🅰 SERIES_KEY​

SERIES_KEY = """series""" #YYYY-MM-DDTHH:MM:SS.SSS

🅰 EVENT_TYPE_KEY​

EVENT_TYPE_KEY = """eventType""" #YYYY-MM-DDTHH:MM:SS.SSS

🅰 EVENT_ID_KEY​

EVENT_ID_KEY = """eventId""" #YYYY-MM-DDTHH:MM:SS.SSS

🅰 IDENTITY_TYPE_KEY​

IDENTITY_TYPE_KEY = """identityType""" #YYYY-MM-DDTHH:MM:SS.SSS

🅰 CALLER_ID_KEY​

CALLER_ID_KEY = """whom""" #YYYY-MM-DDTHH:MM:SS.SSS

🅰 PAYLOAD_KEY​

PAYLOAD_KEY = """payload""" #YYYY-MM-DDTHH:MM:SS.SSS

🅰 METADATA_KEY​

METADATA_KEY = """metadata""" #YYYY-MM-DDTHH:MM:SS.SSS

🅰 MESSAGE_KEY​

MESSAGE_KEY = """message""" #YYYY-MM-DDTHH:MM:SS.SSS

🅰 TIMESTAMP_KEY​

TIMESTAMP_KEY = """timestamp""" #YYYY-MM-DDTHH:MM:SS.SSS

🅰 HISTORY_LEN_KEY​

HISTORY_LEN_KEY = """historyLen""" #YYYY-MM-DDTHH:MM:SS.SSS

🅰 DATETIME_FORMAT​

DATETIME_FORMAT = """%Y-%m-%dT%H:%M:%S.%f""" #YYYY-MM-DDTHH:MM:SS.SSS

🅰 RESULT_KEY​

RESULT_KEY = """result"""

🅰 ERROR_KEY​

ERROR_KEY = """error"""

🅰 REASON_KEY​

REASON_KEY = """reason"""

🅰 EVENT_TYPE_NAME_HANDSHAKE​

EVENT_TYPE_NAME_HANDSHAKE = """handshake"""

🅰 EVENT_TYPE_NAME_WAVEHANDS​

EVENT_TYPE_NAME_WAVEHANDS = """wavehands"""

🅰 EVENT_TYPE_NAME_LOG​

EVENT_TYPE_NAME_LOG = """log"""

🅰 EVENT_TYPE_NAME_ACTION​

EVENT_TYPE_NAME_ACTION = """action""" #===================== HTTP things =====================

🅰 EVENT_TYPE_NAME_SCALAR​

EVENT_TYPE_NAME_SCALAR = """scalar""" #===================== HTTP things =====================

🅰 EVENT_TYPE_NAME_HIST​

EVENT_TYPE_NAME_HIST = """histogram""" #===================== HTTP things =====================

🅰 EVENT_TYPE_NAME_IMAGE​

EVENT_TYPE_NAME_IMAGE = """image""" #===================== HTTP things =====================

🅰 EVENT_TYPE_NAME_VIDEO​

EVENT_TYPE_NAME_VIDEO = """video""" #===================== HTTP things =====================

🅰 EVENT_TYPE_NAME_HPARAMS​

EVENT_TYPE_NAME_HPARAMS = """hyperparameters""" #===================== HTTP things =====================

🅰 EVENT_TYPE_NAME_STATUS​

EVENT_TYPE_NAME_STATUS = """status""" #===================== HTTP things =====================

🅰 EVENT_TYPE_NAME_HARDWARE​

EVENT_TYPE_NAME_HARDWARE = """hardware""" #===================== HTTP things =====================

🅰 EVENT_TYPE_NAME_PROGRESS​

EVENT_TYPE_NAME_PROGRESS = """progress""" #===================== HTTP things =====================

🅰 API_ROOT​

API_ROOT = """/api""" #===================== DB things =====================

🅰 WS_ROOT​

WS_ROOT = """/ws""" #===================== DB things =====================

🅰 ID_COLUMN_NAME​

ID_COLUMN_NAME = ID_KEY #=== TABLE NAMES ===

🅰 TIMESTAMP_COLUMN_NAME​

TIMESTAMP_COLUMN_NAME = TIMESTAMP_KEY #=== TABLE NAMES ===

🅰 NAME_COLUMN_NAME​

NAME_COLUMN_NAME = SERIES_KEY #=== TABLE NAMES ===

🅰 SERIES_COLUMN_NAME​

SERIES_COLUMN_NAME = SERIES_KEY #=== TABLE NAMES ===

🅰 RUN_ID_COLUMN_NAME​

RUN_ID_COLUMN_NAME = RUN_ID_KEY #=== TABLE NAMES ===

🅰 JSON_COLUMN_NAME​

JSON_COLUMN_NAME = METADATA_KEY #=== TABLE NAMES ===

🅰 METADATA_COLUMN_NAME​

METADATA_COLUMN_NAME = METADATA_KEY #=== TABLE NAMES ===

🅰 BLOB_COLUMN_NAME​

BLOB_COLUMN_NAME = """data""" #=== TABLE NAMES ===

🅰 PROJECT_ID_TABLE_NAME​

PROJECT_ID_TABLE_NAME = PROJECT_ID_KEY

🅰 VERSION_TABLE_NAME​

VERSION_TABLE_NAME = """version"""

🅰 RUN_IDS_TABLE_NAME​

RUN_IDS_TABLE_NAME = RUN_ID_KEY

🅰 STATUS_TABLE_NAME​

STATUS_TABLE_NAME = EVENT_TYPE_NAME_STATUS

🅰 LOG_TABLE_NAME​

LOG_TABLE_NAME = """log"""

🅰 IMAGE_TABLE_NAME​

IMAGE_TABLE_NAME = """image"""

🅰 NEETBOX_VERSION​

NEETBOX_VERSION = version("neetbox")

Functions​

🅵 _refresh_version_every​

def _refresh_version_every(sec: int = 60):

🅵 get_timestamp​

def get_timestamp(datetime=None):

Classes​

🅲 IdentityType​

class IdentityType(str, Enum):
    WEB = """web"""
    CLI = """cli"""
    SERVER = """server"""
    SELF = """self"""
    OTHERS = """another"""
    BOTH = """both"""

🅼 __repr__​

def __repr__(self) -> str:

🅲 EventMsg​

@dataclass
class EventMsg:
    project_id: str = None
    run_id: str = None
    event_type: str = None
    series: str = None
    payload: Any = None
    event_id: int = -1
    identity_type: str = None
    timestamp: str = get_timestamp()
    history_len: int = -1
    id: int = None

🅼 json​

@property
def json(self):

🅼 dumps​

def dumps(self):

🅼 loads​

@classmethod
def loads(cls, src):

🅼 merge​

@classmethod
def merge(cls, x: Union["EventMsg", dict], y: Union["EventMsg", dict]):