class documentation
class Dataset:
If you're looking for details about the specific dataset, look at the .description
This classis mostly meant to be instantiated by load(), not by you - it's the thinnest of wrapper classes so you probably wouldn't care to.
This class is provisional and likely to change. Right now it does little more than
- put a description into a .description attribute
- put data into .data attribute without even saying what that is though it's probably an interable giving individually useful things, and be able to tell you its len()gth ...also so that it's harder to accidentally dump gigabytes of text to your console.
This is not the part that does the interpretation. This just contains its results.
| Method | __init__ |
No summary |
| Method | __str__ |
String representation that mentions the name and the number of items |
| Method | export |
Try to export each item to a file, for people who want to continue working on data elsewhere. |
| Instance Variable | data |
Undocumented |
| Instance Variable | description |
Undocumented |
| Instance Variable | name |
Undocumented |
| Instance Variable | num |
Undocumented |
| Parameters | |
description:str | A description that load() would lift from the underlying data. |
| data | A reference to the main data, that load() would load from the underlying data. |
name:str | a name that would be printed into str() representation. Usually set by load(). |
Try to export each item to a file, for people who want to continue working on data elsewhere.
Mostly useful when the dataset actually _does_ store one file (bytes object) per item. For other underlying types we might do some conversion, e.g. dict becomes JSON. We estimate the file extension it should have.