Skip to content

Commit dd3ffdf

Browse files
fracapefracape
committed
add license and gitignore, init readme with compressai startup
1 parent 7412c77 commit dd3ffdf

File tree

4 files changed

+195
-2
lines changed

4 files changed

+195
-2
lines changed

‎.gitignore

+142
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
*.bin
2+
*.inc
3+
*.sh
4+
*.tar.gz
5+
.DS_Store
6+
builds
7+
compressai/version.py
8+
tags
9+
venv*/
10+
venv/
11+
12+
# Created by gitignore.io
13+
### Python ###
14+
# Byte-compiled / optimized / DLL files
15+
__pycache__/
16+
*.py[cod]
17+
*$py.class
18+
19+
# C extensions
20+
*.so
21+
22+
# Distribution / packaging
23+
.Python
24+
build/
25+
develop-eggs/
26+
dist/
27+
downloads/
28+
eggs/
29+
.eggs/
30+
lib/
31+
lib64/
32+
parts/
33+
sdist/
34+
var/
35+
wheels/
36+
pip-wheel-metadata/
37+
share/python-wheels/
38+
*.egg-info/
39+
.installed.cfg
40+
*.egg
41+
MANIFEST
42+
43+
# PyInstaller
44+
# Usually these files are written by a python script from a template
45+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
46+
*.manifest
47+
*.spec
48+
49+
# Installer logs
50+
pip-log.txt
51+
pip-delete-this-directory.txt
52+
53+
# Unit test / coverage reports
54+
htmlcov/
55+
.tox/
56+
.nox/
57+
.coverage
58+
.coverage.*
59+
.cache
60+
nosetests.xml
61+
coverage.xml
62+
*.cover
63+
.hypothesis/
64+
.pytest_cache/
65+
66+
# Translations
67+
*.mo
68+
*.pot
69+
70+
# Django stuff:
71+
*.log
72+
local_settings.py
73+
db.sqlite3
74+
75+
# Flask stuff:
76+
instance/
77+
.webassets-cache
78+
79+
# Scrapy stuff:
80+
.scrapy
81+
82+
# Sphinx documentation
83+
docs/_build/
84+
85+
# PyBuilder
86+
target/
87+
88+
# Jupyter Notebook
89+
.ipynb_checkpoints
90+
91+
# IPython
92+
profile_default/
93+
ipython_config.py
94+
95+
# pyenv
96+
.python-version
97+
98+
# pipenv
99+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in
100+
# version control.
101+
# However, in case of collaboration, if having platform-specific dependencies
102+
# or dependencies
103+
# having no cross-platform support, pipenv may install dependencies that don’t
104+
# work, or not
105+
# install all needed dependencies.
106+
#Pipfile.lock
107+
108+
# celery beat schedule file
109+
celerybeat-schedule
110+
111+
# SageMath parsed files
112+
*.sage.py
113+
114+
# Environments
115+
.env
116+
.venv
117+
env/
118+
venv/
119+
ENV/
120+
env.bak/
121+
venv.bak/
122+
123+
# Spyder project settings
124+
.spyderproject
125+
.spyproject
126+
127+
# Rope project settings
128+
.ropeproject
129+
130+
# mkdocs documentation
131+
/site
132+
133+
# mypy
134+
.mypy_cache/
135+
.dmypy.json
136+
dmypy.json
137+
138+
# Pyre type checker
139+
.pyre/
140+
141+
# PyCharm
142+
.idea/

‎LICENSE

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Copyright (c) 2021-2022, InterDigital Communications, Inc
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without
5+
modification, are permitted (subject to the limitations in the disclaimer
6+
below) provided that the following conditions are met:
7+
8+
* Redistributions of source code must retain the above copyright notice,
9+
this list of conditions and the following disclaimer.
10+
* Redistributions in binary form must reproduce the above copyright notice,
11+
this list of conditions and the following disclaimer in the documentation
12+
and/or other materials provided with the distribution.
13+
* Neither the name of InterDigital Communications, Inc nor the names of its
14+
contributors may be used to endorse or promote products derived from this
15+
software without specific prior written permission.
16+
17+
NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
18+
THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19+
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
20+
NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
21+
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
22+
OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23+
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24+
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25+
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26+
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27+
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28+
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎NEWS.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2022-06-17: Hello CompressAI-VCM!

‎README.md

+24-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
1-
# compressai-vcm
2-
extensions on top of compressai to support Video Coding For Machine applications
1+
# CompressAI-Vision
2+
3+
Extensions on top of CompressAI to support video coding for machine applications
4+
5+
## Installation
6+
7+
CompressAI-Vision supports python 3.6+ and PyTorch 1.7+.
8+
9+
10+
**From source**:
11+
12+
A C++17 compiler, a recent version of pip (19.0+), and common python packages
13+
are also required (see `setup.py` for the full list).
14+
15+
To get started locally and install the development version of CompressAI, run
16+
the following commands in a [virtual environment](https://docs.python.org/3.6/library/venv.html):
17+
18+
```bash
19+
git clone https://github.com/InterDigitalInc/compressai-vision compressai-vision
20+
cd compressai-vcm
21+
pip install -U pip && pip install -e .
22+
```
23+
24+
to be continued

0 commit comments

Comments
 (0)