Skip to content

Commit 650a334

Browse files
committed
api doc
1 parent a1c7336 commit 650a334

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,15 @@
66
[![Development Status](https://img.shields.io/badge/Development%20Status-2%20--%20Pre--Alpha-yellow)](https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha)
77
[![PyPI Shield](https://img.shields.io/pypi/v/sintel.svg)](https://pypi.python.org/pypi/sintel)
88
[![Github Workflow Status](https://img.shields.io/github/workflow/status/signals-dev/sintel/CI)](https://github.com/signals-dev/sintel/actions)
9-
<!-- [![Travis CI Shield](https://travis-ci.org/signals-dev/sintel.svg?branch=master)](https://travis-ci.org/signals-dev/sintel) -->
109
[![Coverage Status](https://codecov.io/gh/signals-dev/sintel/branch/master/graph/badge.svg?token=WwM2IJURrq)](https://codecov.io/gh/signals-dev/sintel)
1110
[![Downloads](https://pepy.tech/badge/sintel)](https://pepy.tech/project/sintel)
12-
<!-- [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/signals-dev/sintel/master?filepath=tutorials) -->
1311
# Sintel
1412

1513
**Sintel** (Signal Intelligence) provides Restful APIs to process massive signal data for anomaly analysis in an efficient and user-friendly way.
1614

1715
* License: [MIT](https://github.com/signals-dev/sintel/blob/master/LICENSE)
1816
* Development Status: [Pre-Alpha](https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha)
1917
* Homepage: https://github.com/sintel-dev/sintel
20-
* Documentation:
21-
* http://mtv.lids.mit.edu:3000/apidocs (Swagger UI style)
22-
* http://mtv.lids.mit.edu:3000/redoc (Redoc UI style)
2318

2419

2520
## Prerequisites
@@ -71,9 +66,13 @@ Run the following command for the purpose of development
7166
$ sintel run -E development -v
7267
```
7368

74-
### Use Your Own Data
69+
### API Documentations
70+
Once the server runs up, you should be able to open the following API interfaces:
7571

72+
- http://localhost:3000/apidocs (Swagger UI style)
73+
- http://localhost:3000/redoc (Redoc UI style)
7674

75+
### Use Your Own Data
7776
Follow the tutorial `.tutorials/Anomaly Detection.ipynb` for detail.
7877

7978

0 commit comments

Comments
 (0)