Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README updates #130

Merged
merged 5 commits into from
Feb 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
[![CircleCI](https://circleci.com/gh/monocongo/cvdata.svg?style=svg)](https://circleci.com/gh/monocongo/cvdata)
[![codecov](https://codecov.io/gh/monocongo/cvdata/branch/master/graph/badge.svg)](https://codecov.io/gh/monocongo/cvdata)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)
# cvdata
Tools for creating and manipulating computer vision datasets

Expand All @@ -18,16 +22,14 @@ $ pip install cvdata
$ pip install -e git+https://github.com/tensorflow/models.git#egg=object_detection\&subdirectory=research
```

##### From Source
##### From source
This package can be installed into the active Python environment as source from
its git repository. We'll first clone/download from GitHub, install the dependencies
specified in `requirements.txt`, and finally install the package into the active
Python environment:
its git repository. We'll first clone/download from GitHub and then install the
package into the active Python environment:
```bash
$ git clone [email protected]:monocongo/cvdata.git
$ cd cvdata
$ pip install -r requirements.txt
$ python setup.py install
$ pip install -e .
```

## OpenImages
Expand Down Expand Up @@ -263,6 +265,14 @@ directories. For example:
$ cvdata_visualize --format pascal --images_dir /data/weapons/images --annotations_dir /data/weapons/pascal
```

### For developers
##### Testing
Tests are based on `pytest` and are launched in stand-alone virtual environments
via [tox](https://tox.readthedocs.io/en/latest/):
```bash
$ tox
```

## Citation
```
@misc {cvdata,
Expand Down
15 changes: 2 additions & 13 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,12 @@ cachetools==4.0.0
certifi==2019.11.28
chardet==3.0.4
contextlib2==0.6.0
-e git+https://github.com/monocongo/cvdata@cb95eefbe926ee0bfdcff244e110c01134d33d5a#egg=cvdata
cycler==0.10.0
Cython==0.29.13
decorator==4.4.0
defusedxml==0.6.0
docutils==0.15.2
entrypoints==0.3
filelock==3.0.10
gast==0.2.2
google-auth==1.11.0
google-auth-oauthlib==0.4.1
Expand All @@ -25,13 +23,10 @@ grpcio==1.26.0
h5py==2.10.0
idna==2.8
ImageHash==4.0
importlib-metadata==0.23
inflect==4.0.0
ipykernel==5.1.2
ipython==7.8.0
ipython-genutils==0.2.0
ipywidgets==7.5.1
jaraco.itertools==5.0.0
jedi==0.15.1
jmespath==0.9.4
jsonschema==3.0.2
Expand All @@ -47,27 +42,23 @@ Markdown==3.1.1
MarkupSafe==1.1.1
matplotlib==3.1.1
mistune==0.8.4
more-itertools==8.1.0
nbconvert==5.6.0
nbformat==4.4.0
notebook==6.0.1
numpy==1.17.2
oauthlib==3.1.0
opencv-python==4.1.2.30
opt-einsum==3.1.0
packaging==20.1
pandas==0.25.3
pandas==1.0.0
pandocfilters==1.4.2
parso==0.5.1
pexpect==4.7.0
pickleshare==0.7.5
Pillow==6.2.0
pluggy==0.12.0
prometheus-client==0.7.1
prompt-toolkit==2.0.10
protobuf==3.10.0
ptyprocess==0.6.0
py==1.8.1
pyasn1==0.4.8
pyasn1-modules==0.2.8
Pygments==2.4.2
Expand All @@ -92,15 +83,13 @@ tensorflow-estimator==2.1.0
termcolor==1.1.0
terminado==0.8.2
testpath==0.4.2
toml==0.10.0
tornado==6.0.3
tqdm==4.42.0
traitlets==4.3.3
urllib3==1.25.8
virtualenv==16.7.5
virtualenv==16.7.9
wcwidth==0.1.7
webencodings==0.5.1
Werkzeug==0.16.0
widgetsnbextension==3.5.1
wrapt==1.11.2
zipp==2.1.0
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,12 @@
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/monocongo/cvdata",
python_requires=">=3.6,<3.8",
python_requires=">=3.7",
provides=[
"cvdata",
],
classifiers=[
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Operating System :: OS Independent",
],
Expand Down