From c59a0b0cbed0ab13f72499eb1b06581608056ca0 Mon Sep 17 00:00:00 2001 From: Andrew DalPino Date: Fri, 19 Jun 2020 22:41:07 -0500 Subject: [PATCH] Additional code style rules --- .php_cs.dist | 4 ++++ README.md | 8 +++----- composer.json | 16 +++++++++++----- 3 files changed, 18 insertions(+), 10 deletions(-) diff --git a/.php_cs.dist b/.php_cs.dist index 0fb3585..5286ecd 100644 --- a/.php_cs.dist +++ b/.php_cs.dist @@ -54,16 +54,20 @@ return Config::create()->setRules([ 'no_short_bool_cast' => true, 'no_singleline_whitespace_before_semicolons' => true, 'no_spaces_around_offset' => true, + 'no_superfluous_phpdoc_tags' => false, 'no_superfluous_elseif' => true, 'no_trailing_comma_in_list_call' => true, 'no_trailing_comma_in_singleline_array' => true, 'no_unneeded_control_parentheses' => true, + 'no_unneeded_curly_braces' => true, + 'no_unset_cast' => true, 'no_unused_imports' => true, 'no_useless_else' => true, 'no_useless_return' => true, 'no_whitespace_before_comma_in_array' => true, 'no_whitespace_in_blank_line' => true, 'normalize_index_brace' => true, + 'nullable_type_declaration_for_default_null_value' => true, 'object_operator_without_whitespace' => true, 'ordered_class_elements' => [ 'order' => [ diff --git a/README.md b/README.md index 0ccc086..f987dbe 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# Rubix ML Server -A library to serve your [Rubix ML](https://github.com/RubixML/RubixML) models in production quickly and effortlessly. +# Rubix Server +Effortlessly serve your trained [Rubix ML](https://github.com/RubixML/RubixML) estimators in production. ## Installation Install Rubix Server using [Composer](https://getcomposer.org/): @@ -697,7 +697,6 @@ use Rubix\Server\Responses\ServerStatusResponse; $response = new ServerStatusResponse($requests, $memoryUsage, 16); ``` ---- ## Testing Rubix utilizes a combination of static analysis and unit tests for quality assurance and to reduce the number of bugs. Rubix provides three [Composer](https://getcomposer.org/) scripts that can be run from the root directory to automate the testing process. @@ -716,6 +715,5 @@ To run the unit tests: $ composer test ``` ---- ## License -[MIT](https://github.com/RubixML/Server/blob/master/LICENSE.md) \ No newline at end of file +The code is licensed [MIT](LICENSE.md) and the documentation is licensed [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/). \ No newline at end of file diff --git a/composer.json b/composer.json index f1b4141..c8665e0 100644 --- a/composer.json +++ b/composer.json @@ -1,13 +1,15 @@ { "name": "rubix/server", "type": "library", - "description": "A library to serve your Rubix ML models quickly and effortlessly.", + "description": "Effortlessly serve your trained Rubix ML estimators in production.", "homepage": "https://github.com/RubixML/Server", "license": "MIT", + "readme": "README.md", "keywords": [ - "php", "machine-learning", "data-science", "model-serving", "server", "microservice", - "json-api", "api", "rest-api", "soa", "cloud", "infrastructure", "ai", "rubix-ml", - "distributed", "client", "rest", "messaging", "hive-mind", "rpc" + "api", "cloud", "distributed", "inference", "inference engine", "inference server", + "infrastructure", "json api", "machine learning", "microservice", "ml", "ml infrastructure", + "model server", "model deployment", "php", "php ml", "prediction", "rest api", "rest server", + "rpc client", "rpc server", "rubix ml", "rubixml", "server" ], "authors": [ { @@ -15,6 +17,10 @@ "email": "me@andrewdalpino.com", "homepage": "https://andrewdalpino.com", "role": "Lead Engineer" + }, + { + "name": "Contributors", + "homepage": "https://github.com/RubixML/Server/graphs/contributors" } ], "require": { @@ -62,7 +68,7 @@ "sort-packages": true }, "support": { - "email": "contact@rubixml.com", + "email": "support@rubixml.com", "issues": "https://github.com/RubixML/Server/issues", "source": "https://github.com/RubixML/Server" },