|
2 | 2 | [](https://www.python.org/downloads/release/python-390/) |
3 | 3 | [](https://pypi.org/project/kern-sdk/0.1.0/) |
4 | 4 |
|
5 | | -# Kern AI API for Python |
6 | 5 |
|
7 | 6 | This is the official Python SDK for [*refinery*](https://github.com/code-kern-ai/refinery), your **open-source** data-centric IDE for NLP. |
8 | 7 |
|
| 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 | + |
9 | 23 | ## Installation |
10 | 24 |
|
11 | 25 | 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: |
75 | 89 |
|
76 | 90 | In this example, there is no manual label, but a weakly supervised label `"Negative"` has been set with 62.2% confidence. |
77 | 91 |
|
78 | | -### Fetch lookup lists |
| 92 | +### Fetching lookup lists |
79 | 93 | 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. |
80 | 94 | ```python |
81 | 95 | list_id = "your-list-id" |
|
188 | 202 |
|
189 | 203 | 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). |
190 | 204 |
|
191 | | -### What's missing? |
| 205 | +#### What's missing? |
192 | 206 | 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". |
193 | 207 |
|
194 | 208 |
|
|
0 commit comments