Skip to content

Commit

Permalink
Pre release 0.0.5 (#6)
Browse files Browse the repository at this point in the history
* Mark custom port task in README as complete

* Bump to version 0.0.5
  • Loading branch information
utkarsh867 authored Apr 13, 2023
1 parent c1ee2da commit 708ba57
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "meteorite"
version = "0.0.4"
version = "0.0.5"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# ☄️ Meteorite

A fast and simple web server to host your Machine Learning model.

<!-- TOC -->
* [☄️ Meteorite](#-meteorite)
* [Install the pip package](#install-the-pip-package)
* [Write your server](#write-your-server)
* [Project status](#project-status)
* [Contribute to ☄️ Meteorite](#contribute-to--meteorite)
<!-- TOC -->

- [☄️ Meteorite](#-meteorite)
- [Install the pip package](#install-the-pip-package)
- [Write your server](#write-your-server)
- [Project status](#project-status)
- [Contribute to ☄️ Meteorite](#contribute-to--meteorite)
<!-- TOC -->

## Install the pip package

Expand Down Expand Up @@ -36,20 +38,20 @@ app.start(port=4000) # port is 4000 by default

By default, the server starts at port `4000`. The `predict` function will run with GET/POST requests on `/predict`.

You can go to http://localhost:4000/predict on your browser to see the result, or use a REST API client to test the
You can go to http://localhost:4000/predict on your browser to see the result, or use a REST API client to test the
endpoint.

## Project status

This project is under active development. We will not recommend you to use this package for critical applications.
This project is under active development. We will not recommend you to use this package for critical applications.
We will welcome all contributions! Please refer to the contributions section for more details.

Some of the features we're still working on:

- [x] Pass POST request String and JSON into the Python function.
- [x] Return String and JSON with the correct content type headers.
- [x] Graceful error handling (⚠️ Priority).
- [ ] Customise the route and port for the main task.
- [x] Customise the port for the server
- [ ] Allow more datatypes for POST request to the model.
- [ ] Create more examples.

Expand Down

0 comments on commit 708ba57

Please sign in to comment.