Skip to content

Commit 8a62f56

Browse files
author
taylor
committed
Merge branch 'master' of github.com:distant-viewing/dvt
2 parents 7a4fad6 + 150169a commit 8a62f56

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ computational analysis of visual culture. It contains low-level architecture
88
for applying state-of-the-art computer vision algorithms to still and moving
99
images. The higher-level functionality of the toolkit allows users to quickly
1010
extract semantic metadata from digitized collections. Extracted information
11-
can be visualized for search and discovery or aggregated and analyzed to find
11+
can be visualized for search and discovery as well as aggregated and analyzed to find
1212
patterns across a corpus.
1313

1414
More information about the toolkit and project is available on the following
@@ -23,7 +23,7 @@ pages:
2323

2424
If you have any trouble using the toolkit, please open a
2525
[GitHub issue](https://github.com/distant-viewing/dvt/issues). If you
26-
have further questions or are interested in collaborating, please contact
26+
have additional questions or are interested in collaborating, please contact
2727
us at tarnold2@richmond.edu and ltilton@richmond.edu.
2828

2929
------------------
@@ -46,7 +46,7 @@ The package can then be installed through PyPI:
4646
pip install dvt
4747
```
4848

49-
Additional Python requirements should be automatically installed automatically
49+
Additional Python requirements should be installed automatically
5050
through PyPI.
5151

5252
## Minimal Demo
@@ -55,7 +55,7 @@ The following code assumes that you have installed the dvt toolkit and have
5555
the video file
5656
[video-clip.mp4](https://github.com/distant-viewing/dvt/raw/master/tests/test-data/video-clip.mp4/)
5757
in your working directory. Run the following command to run the default
58-
pipeline of annotators from the distant viewing toolkit:
58+
pipeline of annotators from dvt:
5959

6060
```
6161
python3 -m dvt video-viz video-clip.mp4
@@ -80,12 +80,12 @@ several video files [here](https://www.distantviewing.org/labs/).
8080

8181
## Getting started with the Python API
8282

83-
The command line tools provide a fast way to get started with the toolkit
84-
but there is much more functionality available when using the full Python
83+
The command line tools provide a fast way to get started with the toolkit,
84+
and there is much more functionality available when using the full Python
8585
API provided by the module.
8686

8787
Using the distant viewing toolkit starts by constructing a `DataExtraction`
88-
object that is associated with some input data (either a video file or a
88+
object that is associated with input data (either a video file or a
8989
collection of still images). Algorithms are then applied to the
9090
`DataExtraction`; the results are stored as Pandas DataFrames and can be
9191
exported as CSV or JSON files. There are two distinct types of algorithms:
@@ -97,7 +97,7 @@ from previously run annotators across across the entire input, but cannot
9797
direclty access the visual data
9898

9999
The separation of algorithms into these two parts makes it easier to write
100-
straightforward, error-free code. It closely mirrors the theory of
100+
straightforward, error-free code. It closely mirrors our
101101
[theory of distant viewing](https://www.distantviewing.org/pdf/distant-viewing.pdf):
102102

103103
> Distant viewing is distinguished from other approaches by making explicit
@@ -117,7 +117,7 @@ the aggregator algorithms perform a 'distant' (e.g., separated from the raw
117117
materials) analysis of the visual inputs.
118118

119119
Here is an example showing the usage of these elements to detect shot breaks
120-
it a video input. We start by running an annotator that detects the differences
120+
in a video input. We start by running an annotator that detects the differences
121121
between subsequent shots and then apply the cut aggregator to determine where
122122
the changes indicate a pattern consistent with a shot break. As in the Minimal
123123
Demo, the code assumes that the video file
@@ -149,7 +149,7 @@ frame_start frame_end
149149
```
150150

151151
There are many annotators and aggregators currently available in the toolkit.
152-
Pipelines, pre-bundled sequences of annotators and aggregators, are also
152+
Pipelines as well as pre-bundled sequences of annotators and aggregators are also
153153
included in the package. Currently available implementations in the toolkit
154154
are:
155155

@@ -203,11 +203,10 @@ describing the tool and its application to the study of visual culture:
203203

204204
Contributions, including bug fixes and new features, to the toolkit are
205205
welcome. When contributing to this repository, please first discuss the change
206-
you wish to make via issue, email, or any other method with the owners of this
206+
you wish to make via a GitHub issue or email with the maintainers of this
207207
repository before making a change. Small bug fixes can be given directly
208208
as pull requests.
209209

210210
Please note that the project has a
211211
[code of conduct](https://github.com/distant-viewing/dvt/blob/master/.github/CODE_OF_CONDUCT.md).
212-
Contributors are expected to follow the guidelines for all interactions with
213-
the project.
212+
Contributors are expected to follow the guidelines.

0 commit comments

Comments
 (0)