porter
latest
Contents:
Installation
Getting Started
REST API
OpenAPI Schemas
Service Architecture
Deployment
Configuration
Error Handling
Logging
Unit Testing porter Apps
Contributing
Example Scripts
Package Reference
porter
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
action (porter.services.BaseService attribute)
(porter.services.BaseService property)
(porter.services.PredictionService property)
add_request_schema() (porter.services.BaseService method)
add_response_schema() (porter.services.BaseService method)
additional_checks (porter.services.PredictionService attribute)
API_VERSION (porter.constants.MODEL_CONTEXT_KEYS attribute)
api_version (porter.services.BaseService attribute)
(porter.services.BaseService property)
(porter.services.PredictionService attribute)
App (class in porter.api)
APP_META (porter.constants.HEALTH_CHECK_KEYS attribute)
AppEncoder (class in porter.utils)
Array (class in porter.schemas)
B
BASE_KEYS (class in porter.constants)
BaseModel (class in porter.datascience)
BasePostProcessor (class in porter.datascience)
BasePreProcessor (class in porter.datascience)
BaseService (class in porter.services)
batch_prediction (porter.services.PredictionService attribute)
Boolean (class in porter.schemas)
C
check_meta() (porter.services.BaseService method)
(porter.services.ModelApp method)
D
default() (porter.utils.AppEncoder method)
(porter.utils.NumpyEncoder method)
(porter.utils.PythonEncoder method)
define_endpoint() (porter.services.BaseService method)
define_id() (porter.services.BaseService method)
DEPLOYED_ON (porter.constants.HEALTH_CHECK_KEYS attribute)
(porter.constants.HEALTH_CHECK_VALUES attribute)
description (porter.services.ModelApp attribute)
docs_json (porter.services.ModelApp attribute)
docs_json_url (porter.services.ModelApp attribute)
docs_prefix (porter.services.ModelApp attribute)
docs_url (porter.services.ModelApp attribute)
E
ENDPOINT (porter.constants.HEALTH_CHECK_SERVICES_KEYS attribute)
endpoint (porter.services.BaseService attribute)
(porter.services.PredictionService attribute)
ERROR (porter.constants.GENERIC_ERROR_KEYS attribute)
ERROR_BODY_KEYS (class in porter.constants)
expose_docs (porter.services.ModelApp attribute)
F
feature_schema (porter.services.PredictionService attribute)
format() (porter.utils.JSONLogFormatter method)
from_file() (porter.datascience.WrappedModel class method)
(porter.datascience.WrappedTransformer class method)
G
GENERIC_ERROR_KEYS (class in porter.constants)
get() (in module porter.api)
get_model_context() (in module porter.api)
get_post_data() (porter.services.BaseService method)
(porter.services.PredictionService method)
H
HEALTH_CHECK_KEYS (class in porter.constants)
HEALTH_CHECK_SERVICES_KEYS (class in porter.constants)
HEALTH_CHECK_VALUES (class in porter.constants)
I
ID (porter.constants.PREDICTION_PREDICTIONS_KEYS attribute)
id (porter.services.BaseService attribute)
(porter.services.BaseService property)
(porter.services.PredictionService attribute)
Integer (class in porter.schemas)
IS_READY (porter.constants.HEALTH_CHECK_VALUES attribute)
J
json_provider_class (porter.api.App attribute)
JSONFormatter (in module porter.utils)
jsonify() (in module porter.api)
(porter.responses.Response method)
JSONLogFormatter (class in porter.utils)
L
load_file() (in module porter.loading)
load_h5() (in module porter.loading)
load_pkl() (in module porter.loading)
log_api_calls (porter.services.BaseService attribute)
(porter.services.PredictionService attribute)
logger (porter.services.ServeAlive attribute)
(porter.services.ServeReady attribute)
M
make_alive_response() (in module porter.responses)
make_batch_prediction_response() (in module porter.responses)
make_docs_html() (in module porter.schemas)
make_error_response() (in module porter.responses)
make_openapi_spec() (in module porter.schemas)
make_prediction_response() (in module porter.responses)
make_ready_response() (in module porter.responses)
MESSAGES (porter.constants.ERROR_BODY_KEYS attribute)
meta (porter.services.BaseService attribute)
(porter.services.ModelApp attribute)
(porter.services.PredictionService attribute)
model (porter.services.PredictionService attribute)
MODEL_CONTEXT (porter.constants.HEALTH_CHECK_SERVICES_KEYS attribute)
(porter.constants.MODEL_CONTEXT_ERROR_KEYS attribute)
(porter.constants.PREDICTION_KEYS attribute)
MODEL_CONTEXT_ERROR_KEYS (class in porter.constants)
MODEL_CONTEXT_KEYS (class in porter.constants)
MODEL_META (porter.constants.MODEL_CONTEXT_KEYS attribute)
MODEL_NAME (porter.constants.MODEL_CONTEXT_KEYS attribute)
ModelApp (class in porter.services)
module
porter.api
porter.config
porter.constants
porter.datascience
porter.exceptions
porter.loading
porter.responses
porter.schemas
porter.services
porter.utils
N
NAME (porter.constants.ERROR_BODY_KEYS attribute)
name (porter.services.BaseService attribute)
(porter.services.BaseService property)
(porter.services.ModelApp attribute)
(porter.services.PredictionService attribute)
namespace (porter.services.BaseService attribute)
(porter.services.BaseService property)
(porter.services.PredictionService attribute)
Number (class in porter.schemas)
NumpyEncoder (class in porter.utils)
O
Object (class in porter.schemas)
object_constants() (in module porter.utils)
P
porter.api
module
porter.config
module
porter.constants
module
porter.datascience
module
porter.exceptions
module
porter.loading
module
porter.responses
module
porter.schemas
module
porter.services
module
porter.utils
module
PORTER_VERSION (porter.constants.HEALTH_CHECK_KEYS attribute)
PorterException
post() (in module porter.api)
postprocessor (porter.services.PredictionService attribute)
predict() (porter.datascience.BaseModel method)
(porter.datascience.WrappedModel method)
PREDICTION (porter.constants.PREDICTION_PREDICTIONS_KEYS attribute)
PREDICTION_KEYS (class in porter.constants)
PREDICTION_PREDICTIONS_KEYS (class in porter.constants)
prediction_schema (porter.services.PredictionService attribute)
PREDICTIONS (porter.constants.PREDICTION_KEYS attribute)
PredictionService (class in porter.services)
preprocessor (porter.services.PredictionService attribute)
process() (porter.datascience.BasePostProcessor method)
(porter.datascience.BasePreProcessor method)
(porter.datascience.WrappedTransformer method)
PythonEncoder (class in porter.utils)
R
REQUEST_ID (porter.constants.BASE_KEYS attribute)
request_id() (in module porter.api)
request_json() (in module porter.api)
request_method() (in module porter.api)
request_schema (porter.services.PredictionService attribute)
request_schemas (porter.services.BaseService attribute)
RequestSchema (class in porter.schemas)
Response (class in porter.responses)
response_schema (porter.services.PredictionService attribute)
response_schemas (porter.services.BaseService attribute)
ResponseSchema (class in porter.schemas)
route_kwargs (porter.services.BaseService property)
(porter.services.PredictionService attribute)
run() (porter.services.ModelApp method)
S
serve() (porter.services.BaseService method)
(porter.services.PredictionService method)
serve_error_message() (in module porter.services)
ServeAlive (class in porter.services)
ServeReady (class in porter.services)
ServeRoot (class in porter.services)
SERVICES (porter.constants.HEALTH_CHECK_KEYS attribute)
set_model_context() (in module porter.api)
StatefulRoute (class in porter.services)
STATUS (porter.constants.HEALTH_CHECK_SERVICES_KEYS attribute)
status (porter.services.BaseService property)
(porter.services.PredictionService property)
String (class in porter.schemas)
T
to_openapi() (porter.schemas.RequestSchema method)
(porter.schemas.ResponseSchema method)
TRACEBACK (porter.constants.ERROR_BODY_KEYS attribute)
U
update_meta() (porter.services.BaseService method)
USER_DATA (porter.constants.ERROR_BODY_KEYS attribute)
V
validate_request_data (porter.services.BaseService attribute)
validate_response_data (porter.services.BaseService attribute)
validate_url() (in module porter.api)
version (porter.services.ModelApp attribute)
W
WrappedModel (class in porter.datascience)
WrappedTransformer (class in porter.datascience)
Read the Docs
v: latest
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds