Skip to content

Commit

Permalink
rework on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
obugrimov committed Jul 1, 2024
1 parent 877152b commit 4e496ec
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 19 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ dist/
.idea

# bench
tests/benchmarks/bench_service/maas/data/models/
tests/benchmarks/bench_service/maas/data/models/
.eggs*
40 changes: 22 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,15 @@
Aqueduct
========

Framework for performance-efficient prediction.
Framework to make youre prediction performance-efficient and scalable.

Key Benefits
============

- Increases the throughput of your machine learning-based service
- Uses shared memory for instantaneous transfer of large amounts of data between processes
- All optimizations in one library


Quickstart
=============

Install using ``pip``:

.. code-block:: shell
pip install aqueduct
Moreover, aqueduct has "optional extras"

- ``numpy`` - support types from numpy in shared memory
- ``aiohttp`` - extension for aiohttp support(see more in examples)

- Supports multiple frameworks

Documentation
=============
Expand All @@ -35,9 +20,9 @@ Documentation
- - `Fundamentals <docs/fundamentals.rst>`_
- - `Example <docs/example.rst>`_
- `Batching <docs/batching.rst>`_
- `F.A.Q. <docs/faq.rst>`_
- `Logging <docs/logging.rst>`_
- `Metrics <docs/metrics.rst>`_
- `F.A.Q. <docs/faq.rst>`_
- Additional features
- - `Sentry support <docs/sentry.rst>`_

Expand All @@ -47,6 +32,25 @@ Examples
- `Aiohttp <examples/aiohttp/>`_
- `Flask <examples/flask/>`_

Installation
=============

Install using ``pip``:

.. code-block:: shell
pip install aqueduct
Moreover, aqueduct has "optional extras"

- ``numpy`` - support types from numpy in shared memory
- ``aiohttp`` - extension for aiohttp support(see more in examples)

.. code-block:: shell
pip install aqueduct[numpy,aiohttp]
Contact Us
==========

Expand Down

0 comments on commit 4e496ec

Please sign in to comment.