Skip to content

Commit db2f5c0

Browse files
JWittmeyerJohannes HöttertianzhouwiertzblSirDegraf
authored
release v1.1.0 (#73)
* Update LICENSE * fixes issue #6 (#7) * fixes issue #6 * Adds GitPython requirement to setup script Co-authored-by: JWittmeyer <[email protected]> * Pip install fix (#8) * pypi 1.0.0 -> 1.0.1 * Pip install fix (#10) * cli as part of refinery module * Adds batch change * Update README.md * Add live star-history graph * Update README.md * Update README.md * Adds different credential ip from docker network * Update Readme * Update issue templates adds feature requests * Update issue templates Automatically set label and assignee for enhancements * Update README.md removes discourse and replaces it with GitHub discussions * Adds volume for minio & qdrant for start & template (#17) * update cli to check for commit hash diff * change cli dialogue * Update issue templates * Update issue templates * Changes the windows ipconfig extraction * implements suggestions from PR #32 and bumps version * Adds update script for pulling newest docker images * Adds bat version of the update for windows - changes to docker-compose command * Add files via upload Co-authored-by: Johannes Hötter <[email protected]> Co-authored-by: tianzhou <[email protected]> Co-authored-by: wiertzbl <[email protected]> Co-authored-by: simonrempel <[email protected]> Co-authored-by: Simon Degraf <[email protected]>
1 parent 4767fb5 commit db2f5c0

File tree

20 files changed

+277
-68
lines changed

20 files changed

+277
-68
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Bug report
33
about: Create a report to help us improve
44
title: "[BUG] - Your title"
5-
labels: bug
5+
labels: bug, enhancement
66
assignees: jhoetter
77

88
---
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Documentation
3+
about: Help us improve the documentation of refinery
4+
title: "[DOC] - Your description"
5+
labels: documentation
6+
assignees: jhoetter
7+
8+
---
9+
10+
Please pick one of the following options:
11+
12+
**What is missing in the docs?**
13+
What were you trying to do that was not covered by the documentation?
14+
15+
_OR_
16+
17+
**Which page is this issue related to?**
18+
If you find an issue with our documentation, what would you like to have improved/changed?
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: jhoetter
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Usability improvement
3+
about: Help us improve our workflow
4+
title: "[UX] - Your title"
5+
labels: usability
6+
assignees: jhoetter
7+
8+
---
9+
10+
**What would you improve?**
11+
List some screenshots here or describe what you're missing.

.github/dependabot.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: 2
2+
updates:
3+
# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem
4+
- package-ecosystem: "pip"
5+
directory: "/"
6+
schedule:
7+
interval: "daily"
8+
# default is / which breaks drone
9+
pull-request-branch-name:
10+
separator: "-"
11+
# not created automatically for version updates so only security ones are created
12+
# https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates#overriding-the-default-behavior-with-a-configuration-file
13+
open-pull-requests-limit: 0
14+

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ refinery/docker-compose.yml
55
refinery/docker-compose.yml.bak
66
refinery/oathkeeper/jwks.json
77
refinery/postgres-data
8+
refinery/minio-data
9+
refinery/qdrant-data
810

911

1012
.DS_Store

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [yyyy] [name of copyright owner]
189+
Copyright 2022 onetask.ai GmbH
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
</p>
66

77
<p align=center>
8-
<a href="https://pypi.org/project/kern-refinery/1.0.0/"><img src="https://img.shields.io/badge/pypi-1.0.0-yellow.svg" alt="pypi 1.0.0"></a>
8+
<a href="https://pypi.org/project/kern-refinery/1.0.3/"><img src="https://img.shields.io/badge/pypi-1.0.3-yellow.svg" alt="pypi 1.0.3"></a>
99
<a href="https://github.com/code-kern-ai/refinery/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-success" alt="Apache 2.0 License"></a>
10-
<a href="https://discuss.kern.ai/"><img src="https://img.shields.io/badge/Forum-F5D14E.svg?logo=discourse" alt="Discourse"></a>
10+
<a href="https://github.com/code-kern-ai/refinery/discussions"><img src="https://img.shields.io/badge/Discussions-gray.svg?logo=github" alt="GitHub Discussions"></a>
1111
<a href="https://discord.gg/qf4rGCEphW"><img src="https://img.shields.io/badge/Discord-gray.svg?logo=discord" alt="Discord"></a>
1212
<a href="https://twitter.com/MeetKern"><img src="https://img.shields.io/badge/Twitter-white.svg?logo=twitter" alt="Twitter"></a>
1313
<a href="https://www.linkedin.com/company/kern-ai"><img src="https://img.shields.io/badge/LinkedIn-0A66C2.svg?logo=linkedin" alt="LinkedIn"></a>
@@ -18,7 +18,7 @@
1818
<a href="https://www.kern.ai/"><img src="https://img.shields.io/badge/Web-white.svg" alt="Website"></a>
1919
</p>
2020

21-
Kern AI refinery (abbr. _refinery_) is like the data-centric sibling of your favorite programming environment. It provides an easy-to-use interface for weak supervision as well as extensive data management, neural search and monitoring to ensure that the quality of your training data is as good as possible.
21+
Kern AI refinery (abbr. _refinery_) is like the data-centric sibling of your favorite programming environment. It provides an easy-to-use interface for weak supervision as well as extensive data management, neural search, and monitoring to ensure that the quality of your training data is as good as possible.
2222

2323
_refinery_ doesn't get rid of manual labeling, but it makes sure that your valuable time is spent well.
2424

@@ -27,7 +27,6 @@ _refinery_ doesn't get rid of manual labeling, but it makes sure that your valua
2727
_refinery_ consists of multiple microservices to enable a scalable and optimized workload balance, so this is the central repository used to orchestrate the system. It builds on top of [🤗 Hugging Face](https://www.huggingface.co) and [spaCy](https://spacy.io/) to leverage pre-built language models for your NLP tasks, as well as [qdrant](https://github.com/qdrant/qdrant) for neural search. Our microservices natively support GPU acceleration.
2828

2929
## Table of contents
30-
- [Table of contents](#table-of-contents)
3130
- [🧑‍💻 Why _refinery_? Built for developers with collaboration in mind](#-why-refinery-built-for-developers-with-collaboration-in-mind)
3231
- [Open-source and developer-oriented](#open-source-and-developer-oriented)
3332
- [For automation or quality control](#for-automation-or-quality-control)
@@ -55,6 +54,7 @@ _refinery_ consists of multiple microservices to enable a scalable and optimized
5554
- [🏠 Architecture](#-architecture)
5655
- [🏫 Glossary](#-glossary)
5756
- [👩‍💻👨‍💻 Team and contributors](#-team-and-contributors)
57+
- [🌟 Star History](#-star-history)
5858
- [📃 License](#-license)
5959

6060

@@ -72,7 +72,7 @@ The labeling workflow in _refinery_ is designed to integrate heuristics like lab
7272
While doing so, we aim to improve the collaboration between engineers and subject matter experts (SMEs). In the past, we've seen how our application was being used in meetings to discuss label patterns in form of labeling functions and distant supervisors. We believe that data-centric AI is the best way to leverage collaboration.
7373

7474
### Integrations
75-
Lastly, _refinery_ supports [SDK actions](https://github.com/code-kern-ai/refinery-python) like pulling and pushing data. Data-centric AI redefines labeling to be more than a one-time job by giving it an iterative workflow, so we aim to give you more power every day by providing end-to-end capabilities, growing the large-scale availability of high-quality training data. Use our SDK to program integrations with your existing landscapes. By the way, tell us which integrations you'd like to have [here](https://discuss.kern.ai/c/enhancements/6).
75+
Lastly, _refinery_ supports [SDK actions](https://github.com/code-kern-ai/refinery-python) like pulling and pushing data. Data-centric AI redefines labeling to be more than a one-time job by giving it an iterative workflow, so we aim to give you more power every day by providing end-to-end capabilities, growing the large-scale availability of high-quality training data. Use our SDK to program integrations with your existing landscapes.
7676

7777

7878
### Your benefits
@@ -97,7 +97,7 @@ If you like what we're working on, please leave a ⭐!
9797
- Overview of project metrics like label distributions and confusion matrix
9898
- Data accessible and extendable via our [Python SDK](https://github.com/code-kern-ai/refinery-python)
9999

100-
### Team workspaces in the [managed version](https://kern.ai/pricing)
100+
### Team workspaces in the [managed version](https://www.kern.ai/pricing/options)
101101
- Allow multiple users to label your data
102102
- Automated calculation of inter-annotator agreements
103103

@@ -107,7 +107,7 @@ If you like what we're working on, please leave a ⭐!
107107
```
108108
pip install kern-refinery
109109
```
110-
Once the library is installed, go to the directory where you want to store the data and run `refinery start`. To stop the server, run `refinery stop`.
110+
Once the library is installed, go to the directory where you want to store the data and run `refinery start`. This will automatically `git clone` this repository first if you haven't done so yet. To stop the server, run `refinery stop`.
111111

112112
### From repository
113113

@@ -146,14 +146,10 @@ If you need help writing your first labeling functions, look into our [template
146146
You can find our changelog [here](https://docs.kern.ai/changelog).
147147

148148
## 😵‍💫 Need help?
149-
No worries, we've got you:
150-
- If you run into issues during installation or have other technical questions, please [open a ticket](https://discuss.kern.ai/c/technical-help/9) in the "technical help" category of our forum.
151-
- If you're not sure how to apply heuristics or have general questions about the workflow of _refinery_, please [open a ticket](https://discuss.kern.ai/c/questions/5) in our "_refinery_ help" category of our forum.
149+
No worries, we've got you. If you have questions, please [open a ticket](https://github.com/code-kern-ai/refinery/discussions/categories/q-a) in the "q&a" category of our forum.
152150

153151
## 🪢 Community and contact
154-
Feel free to join our community spaces, where we'll discuss about recent findings in data-centric AI:
155-
- [Discord](https://discord.gg/qf4rGCEphW)
156-
- [Our forum](https://discuss.kern.ai/)
152+
Feel free to join our [Discord](https://discord.gg/qf4rGCEphW), where we'll discuss about recent findings in data-centric AI:
157153

158154
We send out a (mostly) weekly newsletter about recent findings in data-centric AI, product highlights in development and more. You can subscribe to the newsletter [here](https://www.kern.ai/resources/newsletter).
159155

@@ -162,7 +158,7 @@ Also, you can follow us on [Twitter](https://twitter.com/MeetKern) and [LinkedIn
162158
To reach out to us, please use our [contact formula](https://www.kern.ai/contact).
163159

164160
## 🙌 Contributing
165-
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. You can do so by providing feedback about [desired features](https://discuss.kern.ai/c/enhancements/6) and [bugs](https://github.com/code-kern-ai/refinery/issues) you might detect.
161+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. You can do so by providing feedback about [desired features and bugs](https://github.com/code-kern-ai/refinery/issues) you might detect.
166162

167163
If you actively want to participate in extending the code base, [reach out to us]([mailto:[email protected]](https://www.kern.ai/contact)). We'll explain you how the architecture is set up, so you can customize the application as you desire.
168164

@@ -213,7 +209,7 @@ You can find our short- to midterm feature plans in the [public roadmap](https:/
213209

214210
<details>
215211
<summary><b>I want to install a library for my labeling function</b></summary>
216-
For this, we need to change the requirements.txt of the <a href="https://github.com/code-kern-ai/refinery-lf-exec-env">lf-exec-env</a>, the containerized execution environment for your labeling functions. Please just <a href="https://discuss.kern.ai/c/enhancements/6">open a ticket</a> in our forum, and we'll integrate your library as soon as possible.
212+
For this, we need to change the requirements.txt of the <a href="https://github.com/code-kern-ai/refinery-lf-exec-env">lf-exec-env</a>, the containerized execution environment for your labeling functions. Please just <a href="https://github.com/code-kern-ai/refinery/issues">open an issue</a>, and we'll integrate your library as soon as possible.
217213
</details>
218214

219215
<details>
@@ -478,6 +474,8 @@ Missing anything in the glossary? [Add the term](https://github.com/code-kern-ai
478474
</tr>
479475
</table>
480476

477+
## 🌟 Star History
478+
[![Star History Chart](https://api.star-history.com/svg?repos=code-kern-ai/refinery&type=Date)](https://star-history.com/#code-kern-ai/refinery&Date)
481479

482480
## 📃 License
483481
_refinery_ is licensed under the Apache License, Version 2.0. View a copy of the [License file](LICENSE).

cli.py

Lines changed: 0 additions & 34 deletions
This file was deleted.

publish.sh

100644100755
File mode changed.

0 commit comments

Comments
 (0)