Skip to content

Commit

Permalink
change RWADME.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Deys Timofey committed Oct 10, 2023
1 parent 37c5d2c commit c3589db
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ pip install "pymlup[onnx]" # For onnx models: torch, tensorflow, sklear

### Examples code

<details>

```python
import mlup

Expand Down Expand Up @@ -199,8 +201,12 @@ up.conf.auto_detect_predict_params = False
up.ml.load_model_settings()
```

</details>

### Examples server commands

<details>

#### mlup run

You can run web application from model, config, pickle up object. Bash command mlup run making this.
Expand Down Expand Up @@ -418,8 +424,12 @@ See `mlup validate-config --help` or [Description of the bash commands](https://
mlup validate-config /path/to/my/conf.yaml
```

</details>

## Web application interface

<details>

By default, web application starting on http://localhost:8009 and have api docs.

See [Web app API](https://github.com/nxexox/pymlup/tree/main/docs/web_app_api.md) for more details.
Expand Down Expand Up @@ -570,8 +580,12 @@ By default, this param is `mlup.ml.data_transformers.numpy_data_transformer.Nump

This method have validation for inner request data. It's making from config `columns` and flag `column_validation`.

</details>

## Web application modes

<details>

See [Web app architectures](https://github.com/nxexox/pymlup/tree/main/docs/web_app_architectures.md) for more details.

Web application have three works modes:
Expand Down Expand Up @@ -611,6 +625,8 @@ up = mlup.UP(
)
```

</details>

## Metrics

MLup PyPi download statistics: https://pepy.tech/project/pymlup
Expand Down

0 comments on commit c3589db

Please sign in to comment.