Skip to content

Commit c82a4d8

Browse files
committed
Improve examples README and add back deleted lines to .gitignore
1 parent e82c818 commit c82a4d8

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ dependencies/
1212
*.bin
1313
*.csv
1414

15+
# Ignore everything in examples/ except the task dirs
16+
!examples
17+
examples/*
18+
!examples/tabular-classification
19+
!examples/text-classification
1520

1621
# Documentation generated files #
1722
#################################

examples/README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,24 @@
22
<img src="logo-blue-text.svg"><br>
33
</div>
44

5-
# Examples Gallery | Unbox AI
5+
# Examples Gallery | Unbox AI
6+
67
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Unbox:%20The%20debugging%20workspace%20for%20ML%20&url=https://github.com/unboxai&via=unbox_ai&hashtags=mlops)
78
[![PyPI Latest Release](https://img.shields.io/pypi/v/unboxapi.svg)](https://pypi.org/project/unboxapi/)
89
[![downloads](https://pepy.tech/badge/unboxapi)](https://pepy.tech/project/unboxapi)
910

10-
This repository contains a gallery of sample notebooks illustrating the process of **creating projects and uploading models & datasets** to the Unbox platform.
11+
This repository contains a gallery of sample notebooks illustrating the process of **creating projects and uploading models & datasets** to the Unbox platform.
1112

1213
## Why this repository exists?
1314

1415
This repository fulfils two main goals:
1516

16-
1. It demonstrates our Python API in action; and
17-
2. It provides toy examples that may be somewhat similar to the problems you are solving at your organization.
17+
1. It demonstrates our Python API in action
18+
2. It provides simple examples that may be similar to the problems you are solving at your organization.
1819

19-
We take privacy seriously and understand that sometimes, your actual models and datasets are sensible and cannot be uploaded to our community edition platform. No worries, we got you covered. Unbox also offers an on-premise solution that you can host in your own virtual private cloud (VPC).
20+
We take privacy & security very seriously and understand that your models and datasets might contain sensitive or proprietary information. [Reach out to us](mailto:founders@unbox.ai) if you are interested in our on-premise solution.
2021

21-
In that case, pick a task type, model framework or problem that shares similarities with your actual models / datasets and start exploring Unbox's right away! If you like it, [contact us](mailto:founders@unbox.ai) and we can discuss the best solution for your organization's needs.
22+
In the meantime, pick a task, model framework or problem that shares similarities with something you are working on and start exploring Unbox right away!
2223

2324
## What is Unbox?
2425

@@ -28,9 +29,9 @@ Unbox is a debugging workspace for ML & Data Science. Unbox combines and builds
2829

2930
## Installation
3031

31-
To run the notebooks on this repository, you'll need to have the `unboxapi` module installed.
32+
To run the notebooks in this repository, you'll need to have the `unboxapi` library installed.
3233

33-
You can do so with with PyPI (pip)
34+
Install with PyPI (pip)
3435

3536
```console
3637
pip install --upgrade unboxapi
@@ -44,7 +45,7 @@ conda install unboxapi --channel conda-forge
4445

4546
## Documentation
4647

47-
This repository complements the rest of the documentation. Navigate [here](https://docs.unbox.ai) for a quickstart guide and for in-depth tutorials. The full Python API reference can be found [here](https://reference.unbox.ai).
48+
This repository complements the rest of the documentation. Navigate [here](https://docs.unbox.ai) for a quickstart guide and for in-depth tutorials. The full Python library reference can be found [here](https://reference.unbox.ai).
4849

4950
## Contributing
5051

0 commit comments

Comments
 (0)