Skip to content

Commit 504d7a9

Browse files
authored
simplify readme
1 parent 5eefe7e commit 504d7a9

File tree

1 file changed

+6
-18
lines changed

1 file changed

+6
-18
lines changed

README.md

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@ CleanVision is super simple -- run the same couple lines of Python code to audit
1313
[![os](https://img.shields.io/badge/platform-noarch-lightgrey)](https://pypi.org/pypi/cleanvision/)
1414
[![py\_versions](https://img.shields.io/badge/python-3.7%2B-blue)](https://pypi.org/pypi/cleanvision/)
1515
[![codecov](https://codecov.io/github/cleanlab/cleanvision/branch/main/graph/badge.svg?token=y1N6MluN9H)](https://codecov.io/gh/cleanlab/cleanvision)
16-
[![Slack Community](https://img.shields.io/static/v1?logo=slack&style=flat&color=white&label=slack&message=community)](https://cleanlab.ai/slack)
17-
[![Twitter](https://img.shields.io/twitter/follow/CleanlabAI?style=social)](https://twitter.com/CleanlabAI)
18-
[![Cleanlab Studio](https://raw.githubusercontent.com/cleanlab/assets/master/shields/cl-studio-shield.svg)](https://cleanlab.ai/studio/?utm_source=github&utm_medium=readme&utm_campaign=clostostudio)
1916

2017
## Installation
2118
```shell
@@ -57,15 +54,15 @@ imagelab.report(issue_types=issue_types)
5754
```
5855

5956

60-
## More resources on how to use CleanVision
57+
## More resources
6158

6259
- [Tutorial](https://cleanvision.readthedocs.io/en/latest/tutorials/tutorial.html)
60+
- [Blog](https://cleanlab.ai/blog/cleanvision/)
61+
- [Documentation](https://cleanvision.readthedocs.io/)
6362
- [Run CleanVision on a HuggingFace dataset](https://cleanvision.readthedocs.io/en/latest/tutorials/huggingface_dataset.html)
6463
- [Run CleanVision on a Torchvision dataset](https://cleanvision.readthedocs.io/en/latest/tutorials/torchvision_dataset.html)
6564
- [Example script](https://github.com/cleanlab/cleanvision/blob/main/docs/source/tutorials/run.py) that can be run with: `python examples/run.py --path <FOLDER_WITH_IMAGES>`
6665
- [Additional example notebooks](https://github.com/cleanlab/cleanvision-examples)
67-
- [Documentation](https://cleanvision.readthedocs.io/)
68-
- [Blog Post](https://cleanlab.ai/blog/cleanvision/)
6966
- [FAQ](https://cleanvision.readthedocs.io/en/latest/faq.html)
7067

7168
## *Clean* your data for better Computer *Vision*
@@ -91,27 +88,18 @@ In any collection of image files (most [formats](https://pillow.readthedocs.io/e
9188
| 8 | Odd Aspect Ratio | Images with an unusual aspect ratio (overly skinny/wide) | odd_aspect_ratio | ![](https://raw.githubusercontent.com/cleanlab/assets/master/cleanvision/example_issue_images/odd_aspect_ratio.jpg) |
9289
| 9 | Odd Size | Images that are abnormally large or small compared to the rest of the dataset | odd_size | <img src="https://raw.githubusercontent.com/cleanlab/assets/master/cleanvision/example_issue_images/odd_size.png" width=20% height=20%> |
9390

94-
CleanVision supports Linux, macOS, and Windows and runs on Python 3.7+.
95-
96-
## Join our community
97-
98-
* The best place to learn is [our Slack community](https://cleanlab.ai/slack). Join the discussion there to see how
99-
folks are using this library, discuss upcoming features, or ask for private support.
91+
CleanVision supports Linux, macOS, and Windows and runs on Python 3.7+. Learn more from our [blog](https://cleanlab.ai/blog/cleanvision/).
10092

101-
* Need professional help with CleanVision? Join our [\#help Slack channel](https://cleanlab.ai/slack) and message us there, or reach out via email: [email protected]
93+
## Community
10294

10395
* Interested in contributing? See the [contributing guide](CONTRIBUTING.md). An easy starting point is to
104-
consider [issues](https://github.com/cleanlab/cleanvision/labels/good%20first%20issue) marked `good first issue` or
105-
simply reach out in [Slack](https://cleanlab.ai/slack). We welcome your help building a standard open-source library
106-
for data-centric computer vision!
96+
consider [issues](https://github.com/cleanlab/cleanvision/labels/good%20first%20issue) marked `good first issue`.
10797

10898
* Ready to start adding your own code? See the [development guide](DEVELOPMENT.md).
10999

110100
* Have an issue? [Search existing issues](https://github.com/cleanlab/cleanvision/issues?q=is%3Aissue)
111101
or [submit a new issue](https://github.com/cleanlab/cleanvision/issues/new/choose).
112102

113-
* Have ideas for the future of data-centric computer vision? Check
114-
out [our active/planned Projects and what we could use your help with](https://github.com/cleanlab/cleanvision/projects).
115103

116104
## License
117105

0 commit comments

Comments
 (0)