Skip to content

Commit deece9d

Browse files
committed
Add README
1 parent 02313f6 commit deece9d

File tree

2 files changed

+51
-3
lines changed

2 files changed

+51
-3
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# DataQA
2+
3+
TODO: Add logo here
4+
5+
DataQA is a tool to perform AI model quality assessment (QA) using an interactive app that can be shared with technical and non-technical members of your team.
6+
7+
TODO: Add a gif.
8+
9+
The official documentation page is at: [docs.dataqa.ai]().
10+
11+
# Installation
12+
13+
`pip install dataqa`
14+
15+
# Quick start
16+
17+
## Step 1: create an account
18+
19+
Go to (https://app.dataqa.ai/)[https://app.dataqa.ai/login] and follow the steps to create your first project. Once your account and your first project have been created, you will see a screen such as this one:
20+
21+
TODO: Add screenshot of the screen with the publish string
22+
23+
You will need this key later in order to be able to create your first QA app. You can always come back to this page to find it.
24+
25+
## Step 2: Publish your data
26+
27+
Creating your first shareable QA app is as simple as this:
28+
29+
```python
30+
import pandas as pd
31+
from lib.publish import DataQA
32+
dataqa = DataQA()
33+
dataqa.login()
34+
# Prompt username and password
35+
df = pd.DataFrame([[1, "Laptop", 1600], [2, "Mouse", 10]], columns=["id", "product", "price"])
36+
dataqa.publish(PROJECT_ID, df)
37+
```
38+
39+
The `PROJECT_ID` is the hash string on the dataqa project page.
40+
41+
## Step 3: Use the UI to explore your data
42+
43+
TODO: add screenshot or GIF
44+

pyproject.toml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
[tool.poetry]
2-
name = "dataqa-python"
3-
version = "0.1.0"
4-
description = ""
2+
name = "dataqa"
3+
version = "2.0.1"
4+
description = "Python Client library for DataQA"
55
authors = ["Maria Mestre <maria@dataqa.ai>","Stuart Quin <stuart@dataqa.ai>"]
6+
readme = "README.md"
7+
homepage = "https://dataqa.ai"
8+
repository = "https://github.com/dataqa/dataqa-python"
9+
documentation = "https://docs.dataqa.ai"
610

711
[tool.poetry.dependencies]
812
python = "^3.8"

0 commit comments

Comments
 (0)