Skip to content

Commit

Permalink
Initial migration of DataGrid to its new home
Browse files Browse the repository at this point in the history
  • Loading branch information
dsblank committed Oct 12, 2022
1 parent 34d3991 commit d84a518
Show file tree
Hide file tree
Showing 46 changed files with 8,449 additions and 2 deletions.
8 changes: 8 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# This is an example .flake8 config, used when developing *Black* itself.
# Keep in sync with setup.cfg which is used for source packages.

[flake8]
ignore = E203, E266, E501, W503
max-line-length = 80
select = B,C,E,F,W,T4,B9
copyright-check = True
8 changes: 8 additions & 0 deletions .isort.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[settings]
sections=FUTURE,STDLIB,THIRDPARTY,FIRSTPARTY,LOCALFOLDER
multi_line_output=3
include_trailing_comma=True
force_grid_wrap=0
combine_as_imports=True
line_length=88
use_parentheses = True
24 changes: 24 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.3.0 # Use the ref you want to point at
hooks:
- id: check-json
- id: check-merge-conflict
- id: debug-statements
- id: trailing-whitespace
- repo: https://github.com/timothycrosley/isort
rev: 5.10.1
hooks:
- id: isort
- repo: https://github.com/ambv/black
rev: 22.6.0
hooks:
- id: black
args: [--safe]
- repo: https://gitlab.com/pycqa/flake8
rev: 3.9.2
hooks:
- id: flake8
args: ['--config=.flake8']
exclude: '^(tests/.*)|(train-examples/releases_examples/.*)$'
additional_dependencies: ['flake8-coding==1.3.2', 'flake8-copyright==0.2.2']
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,43 @@
# kangas
A fast, scalable datagrid tool for exploring data
# Kangas DataGrid

The high-performance, multimedia grid tool for data analysis and
exploration.

## What is Kangas DataGrid?

Kangas DataGrid is a Python library for creating a table of text, numbers,
and images, and then exploring them via a web browser-based UI.

### A short example

```python
from kangas import DataGrid, Image

dg = DataGrid(
name="Short Example",
columns=["Category", "Image", "Output"],
)


model = build_model()
model.fit(x_train, y_train)
outputs = model.predict(x_test)

for index in range(len(x_test)):
dg.append([
y_test[index],
Image(x_test[index]),
outputs[index].argmax(),
])

dg.show()
```

<img src="https://github.com/comet-ml/kangas/blob/main/docs/imgs/short-example.png"></img>
<img src="https://github.com/comet-ml/kangas/blob/main/docs/imgs/short-example-group-by-category.png"></img>

## Further Documentation

1. <a href="https://github.com/comet-ml/kangas/blob/main/README.md">General README</a>
2. <a href="https://github.com/comet-ml/kangas/blob/main/README-filters.md">DataGrid Filters</a>
3. <a href="https://github.com/comet-ml/kangas/blob/main/notebooks/DataGrid-Getting%20Started.ipynb">Getting Started</a> - Jupyter Notebook
Loading

0 comments on commit d84a518

Please sign in to comment.