Skip to content

Commit e7a05ba

Browse files
committed
Update documentation
1 parent ba5c1d1 commit e7a05ba

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

+19-8
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,17 @@
99

1010
<img src="https://marketplace.deep-hybrid-datacloud.eu/images/logo-deep.png" width=200 alt="DEEP-Hybrid-DataCloud logo"/>
1111

12-
DEEP as a Service (DEEPaaS) is a REST API that is focused on providing access
13-
to machine learning models. By using DEEPaaS users can easily run a REST API
14-
in front of their model, thus accessing its functionality via HTTP calls.
12+
DEEP as a Service API (DEEPaaS API) is a REST API built on
13+
[aiohttp](https://docs.aiohttp.org/) that allows to provide easy access to
14+
machine learning, deep learning and artificial intelligence models. By using
15+
the DEEPaaS API users can easily run a REST API in front of their model, thus
16+
accessing its functionality via HTTP calls. DEEPaaS API leverages the [OpenAPI
17+
specification](https://github.com/OAI/OpenAPI-Specification).
18+
19+
# Documentation
20+
21+
The DEEPaaS documentation is hosted on [Read the Docs](https://deepaas.readthedocs.io/).
22+
1523

1624
## Quickstart
1725

@@ -22,7 +30,7 @@ The best way to quickly try the DEEPaaS API is through:
2230
This command will install a virtualenv (in the `virtualenv` directory) with
2331
DEEPaaS and all its dependencies and will run the DEEPaaS REST API, listening
2432
on `127.0.0.1:5000`. If you browse to `http://127.0.0.1:5000` you will get the
25-
swagger documentation page.
33+
Swagger documentation page (i.e. the Swagger web UI).
2634

2735
### Develop mode
2836

@@ -31,10 +39,6 @@ issue the following command before:
3139

3240
make develop
3341

34-
# Documentation
35-
36-
The DEEPaaS documentation is hosted on [Read the Docs](https://deepaas.readthedocs.io/).
37-
3842

3943
# Citing
4044

@@ -64,3 +68,10 @@ You can also use the following BibTeX entry:
6468
year = {2019},
6569
month = {10},
6670
day = {25},}
71+
72+
# Acknowledgements
73+
74+
This software has been developed within the DEEP-Hybrid-DataCloud (Designing
75+
and Enabling E-infrastructures for intensive Processing in a Hybrid DataCloud)
76+
project that has received funding from the European Union’s Horizon 2020
77+
research and innovation programme under grant agreement No 777435.

0 commit comments

Comments
 (0)