Skip to content

Commit 4d43bd7

Browse files
author
Johannes Hötter
committed
update README
1 parent c0ca027 commit 4d43bd7

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,24 @@
22
[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-390/)
33
[![pypi 0.1.0](https://img.shields.io/badge/pypi-0.1.0-yellow.svg)](https://pypi.org/project/kern-sdk/0.1.0/)
44

5-
# Kern AI API for Python
65

76
This is the official Python SDK for [*refinery*](https://github.com/code-kern-ai/refinery), your **open-source** data-centric IDE for NLP.
87

8+
**Table of Contents**
9+
- [Installation](#installation)
10+
- [Usage](#usage)
11+
- [Creating a `Client` object](#creating-a-client-object)
12+
- [Fetching labeled data](#fetching-labeled-data)
13+
- [Fetching lookup lists](#fetching-lookup-lists)
14+
- [Upload files](#upload-files)
15+
- [Adapters](#adapters)
16+
- [Rasa](#rasa)
17+
- [What's missing?](#whats-missing)
18+
- [Roadmap](#roadmap)
19+
- [Contributing](#contributing)
20+
- [License](#license)
21+
- [Contact](#contact)
22+
923
## Installation
1024

1125
You can set up this SDK either via running `$ pip install kern-sdk`, or by cloning this repository and running `$ pip install -r requirements.txt`.
@@ -75,7 +89,7 @@ An example export file looks like this:
7589

7690
In this example, there is no manual label, but a weakly supervised label `"Negative"` has been set with 62.2% confidence.
7791

78-
### Fetch lookup lists
92+
### Fetching lookup lists
7993
In your project, you can create lookup lists to implement distant supervision heuristics. To fetch your lookup list(s), you can either get all or fetch one by its list id.
8094
```python
8195
list_id = "your-list-id"
@@ -188,7 +202,7 @@ nlu:
188202

189203
Please make sure to also create the further necessary files (`domain.yml`, `data/stories.yml` and `data/rules.yml`) if you want to train your Rasa chatbot. For further reference, see their [documentation](https://rasa.com/docs/rasa).
190204

191-
### What's missing?
205+
#### What's missing?
192206
Let us know what open-source/closed-source NLP framework you are using, for which you'd like to have an adapter implemented in the SDK. To do so, simply create an issue in this repository with the tag "enhancement".
193207

194208

0 commit comments

Comments
 (0)