Commit 084f6bd9 authored by Niels-Oliver Walkowski's avatar Niels-Oliver Walkowski
Browse files

feat(doc): Add doc to Corpus class

Add documentation for the basedir attribute.
parent 5fc6a926
......@@ -10,6 +10,12 @@ SUMMARY = {'seqmean': {'monochromatic': ['luminance'],
class Corpus(object):
"""Main class for working with a corpus of movies and movie data
Attributes:
basedir (pathlib.Path) -- The root directory in which all moviefolders
together with their data reside.
"""
def __init__(self, path='./', summary=False):
self.basedir = pathlib.Path(path)
self.summary = summary if summary else SUMMARY
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment