Skip to main content

Rekcurd

Build Status PyPI version codecov pypi supported versions

Rekcurd is the Project for serving ML module. This is a gRPC micro-framework and it can be used like Django and Flask.

Parent Project

https://github.com/rekcurd/community

Components

Installation

From source:

$ git clone --recursive https://github.com/rekcurd/rekcurd-python.git
$ cd rekcurd-python
$ pip install -e .

From PyPi directly:

$ pip install rekcurd

How to use

Example is available here. You can generate Rekcurd template and implement necessary methods.

$ rekcurd startapp {Your application name}
$ cd {Your application name}
$ vi app.py
$ python app.py

Unittest

$ python -m unittest

Kubernetes support

Rekcurd can be run on Kubernetes. See community repository.

Type definition

PredictLabel type

V is the length of feature vector.

Field Type Description
input
(required)
One of below
- string
- bytes
- string[V]
- int[V]
- double[V]
Input data for inference.
- "Nice weather." for a sentiment analysis.
- PNG file for an image transformation.
- ["a", "b"] for a text summarization.
- [1, 2] for a sales forcast.
- [0.9, 0.1] for mnist data.
option string Option field. Must be json format.

The "option" field needs to be a json format. Any style is Ok but we have some reserved fields below.

Field Type Description
suppress_log_input bool True: NOT print the input and output to the log message.
False (default): Print the input and outpu to the log message.
YOUR KEY any YOUR VALUE

PredictResult type

M is the number of classes. If your algorithm is a binary classifier, you set M to 1. If your algorithm is a multi-class classifier, you set M to the number of classes.

Field Type Description
label
(required)
One of below
-string
-bytes
-string[M]
-int[M]
-double[M]
Result of inference.
-"positive" for a sentiment analysis.
-PNG file for an image transformation.
-["a", "b"] for a multi-class classification.
-[1, 2] for a multi-class classification.
-[0.9, 0.1] for a multi-class classification.
score
(required)
One of below
-double
-double[M]
Score of result.
-0.98 for a binary classification.
-[0.9, 0.1] for a multi-class classification.
option string Option field. Must be json format.

EvaluateResult type

EvaluateResult is the evaluation score. N is the number of evaluation data. M is the number of classes. If your algorithm is a binary classifier, you set M to 1. If your algorithm is a multi-class classifier, you set M to the number of classes.

Field Type Description
num
(required)
int Number of evaluation data.
accuracy
(required)
double Accuracy.
precision
(required)
double[M] Precision.
recall
(required)
double[M] Recall.
fvalue
(required)
double[M] F1 value.

EvaluateDetail type

EvaluateDetail is the details of evaluation result.

Field Type Description
result
(required)
PredictResult Prediction result.
is_correct
(required)
bool Correct or not.

Release files for rekcurd 1.0.1.post1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rekcurd 1.0.1.post1
File Size Uploaded
rekcurd-1.0.1.post1.tar.gz 30.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for rekcurd 1.0.1.post1
File Interpreter ABI Platform
rekcurd-1.0.1.post1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 69.4 kB

Release files / rekcurd-1.0.1.post1.tar.gz

Download URL rekcurd-1.0.1.post1.tar.gz
Size 30.7 kB
Tags Source
SHA-256 checksum
How to use checksums
df94e323c3ef842ea345e29f983428321c612b5939afa220a368b537564b7f76
BLAKE2b-256 checksum
How to use checksums
50660cff763d98366d566990c536f311e0c32ad3c1b721aaa078fbc4d5fa4dda
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8

Release files / rekcurd-1.0.1.post1-py2.py3-none-any.whl

Download URL rekcurd-1.0.1.post1-py2.py3-none-any.whl
Size 38.7 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
048764fb862055becf0c353a529a1f0cbb60fceeca8c1b9015f6fd035682c4ad
BLAKE2b-256 checksum
How to use checksums
09a23020b159d188ff82115e822bf0bd59649c7fc3d4bf379605df9753b45349
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page