Skip to content

Commit 84414c4

Browse files
author
Johannes Hötter
authored
Update README.md
kern -> refinery
1 parent 1d0cc67 commit 84414c4

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
![kern-python](https://uploads-ssl.webflow.com/61e47fafb12bd56b40022a49/62766400bd3c57b579d289bf_kern-python%20Banner.png)
1+
![refinery SDK](https://uploads-ssl.webflow.com/61e47fafb12bd56b40022a49/62cf1c3cb8272b1e9c01127e_refinery%20sdk%20banner.png)
22
[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-390/)
3-
[![pypi 1.0.1](https://img.shields.io/badge/pypi-1.0.1-yellow.svg)](https://pypi.org/project/kern-sdk/1.0.1/)
3+
[![pypi 1.0.1](https://img.shields.io/badge/pypi-1.0.1-yellow.svg)](https://pypi.org/project/refinery-python/1.0.0/)
44

55

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

88
**Table of Contents**
99
- [Installation](#installation)
@@ -22,15 +22,15 @@ This is the official Python SDK for [*refinery*](https://github.com/code-kern-ai
2222

2323
## Installation
2424

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`.
25+
You can set up this SDK either via running `$ pip install refinery-python`, or by cloning this repository and running `$ pip install -r requirements.txt`.
2626

2727
## Usage
2828

2929
### Creating a `Client` object
3030
Once you installed the package, you can create a `Client` object from any Python terminal as follows:
3131

3232
```python
33-
from kern import Client
33+
from refinery import Client
3434

3535
user_name = "your-username" # this is the email you log in with
3636
password = "your-password"
@@ -69,7 +69,7 @@ df = client.get_record_export(tokenize=False)
6969
# spaCy tokenizer will process your textual data
7070
```
7171

72-
Alternatively, you can also just run `kern pull` in your CLI given that you have provided the `secrets.json` file in the same directory.
72+
Alternatively, you can also just run `refinery pull` in your CLI given that you have provided the `secrets.json` file in the same directory.
7373

7474
The `df` contains both your originally uploaded data (e.g. `headline` and `running_id` if you uploaded records like `{"headline": "some text", "running_id": 1234}`), and a triplet for each labeling task you create. This triplet consists of the manual labels, the weakly supervised labels, and their confidence. For extraction tasks, this data is on token-level.
7575

@@ -113,7 +113,7 @@ upload_was_successful = client.post_file_import(file_path)
113113

114114
We use Pandas to process the data you upload, so you can also provide `import_file_options` for the file type you use. Currently, you need to provide them as a `\n`-separated string (e.g. `"quoting=1\nsep=';'"`). We'll adapt this in the future to work with dictionaries instead.
115115

116-
Alternatively, you can `kern push <path-to-your-file>` via CLI, given that you have provided the `secrets.json` file in the same directory.
116+
Alternatively, you can `refinery push <path-to-your-file>` via CLI, given that you have provided the `secrets.json` file in the same directory.
117117

118118
**Make sure that you've selected the correct project beforehand, and fit the data schema of existing records in your project!**
119119

@@ -125,7 +125,7 @@ Alternatively, you can `kern push <path-to-your-file>` via CLI, given that you h
125125
To do so, do the following:
126126

127127
```python
128-
from kern.adapter import rasa
128+
from refinery.adapter import rasa
129129

130130
rasa.build_intent_yaml(
131131
client,
@@ -148,7 +148,7 @@ nlu:
148148
If you want to provide a metadata-level label (such as sentiment), you can provide the optional argument `metadata_label_task`:
149149

150150
```python
151-
from kern.adapter import rasa
151+
from refinery.adapter import rasa
152152
153153
rasa.build_intent_yaml(
154154
client,
@@ -173,7 +173,7 @@ nlu:
173173
And if you have entities in your texts which you'd like to recognize, simply add the `tokenized_label_task` argument:
174174

175175
```python
176-
from kern.adapter import rasa
176+
from refinery.adapter import rasa
177177
178178
rasa.build_intent_yaml(
179179
client,
@@ -215,7 +215,7 @@ Let us know what open-source/closed-source NLP framework you are using, for whic
215215
- [x] Fetch project statistics
216216

217217

218-
If you want to have something added, feel free to open an [issue](https://github.com/code-kern-ai/kern-python/issues).
218+
If you want to have something added, feel free to open an [issue](https://github.com/code-kern-ai/refinery-python/issues).
219219

220220
## Contributing
221221
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

0 commit comments

Comments
 (0)