Skip to content

Commit ecdc6ec

Browse files
author
Johannes Hötter
authored
Update README.md
1 parent da2b96e commit ecdc6ec

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ password = "your-password"
2121
project_id = "your-project-id" # can be found in the URL of the web application
2222

2323
client = Client(username, password, project_id)
24-
# if you run the application locally, please the following instead:
25-
# client = Client(username, password, project_id, uri="http://localhost:4455")
2624
```
2725

26+
**Caution:** if you run the application locally, please the following instead: `client = Client(username, password, project_id, uri="http://localhost:4455")`
27+
2828
Alternatively, you can provide a `secrets.json` file in your repository, looking as follows:
2929
```json
3030
{
@@ -40,7 +40,7 @@ Now, you can easily fetch the data from your project:
4040
df = client.get_record_export()
4141
```
4242

43-
Alternatively, you can also just run `kern pull` in your CLI given that you have provided the `secrets.json` file.
43+
Alternatively, you can also just run `kern pull` in your CLI given that you have provided the `secrets.json` file. This will download the current data and stores it in a `.json`-file with your project name as its file name.
4444

4545
The `df` contains data of the following scheme:
4646
- all your record attributes are stored as columns, e.g. `headline` or `running_id` if you uploaded records like `{"headline": "some text", "running_id": 1234}`
@@ -52,7 +52,7 @@ The `df` contains data of the following scheme:
5252
With the `client`, you easily integrate your data into any kind of system; may it be a custom implementation, an AutoML system or a plain data analytics framework 🚀
5353

5454
## Roadmap
55-
- [ ] Register information sources via wrappers
55+
- [ ] Register heuristics via wrappers
5656
- [ ] Add project upload
5757
- [x] Fetch project statistics
5858

0 commit comments

Comments
 (0)