Skip to content

Commit

Permalink
readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
GabrielBG0 committed Jul 23, 2024
1 parent fdacd71 commit 5ad6b60
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions minerva/data/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Readers
# Data

| **Reader** | **Data Unit** | **Order** | **Class** | **Observations** |
|-------------------- |----------------------------------------------------------------------------------- |--------------------- |-------------------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------ |
| PNGReader | Each unit of data is a image file (PNG) inside the root folder | Lexigraphical order | minerva.data.readers.png_reader.PNGReader | File extensions: .png |
| TIFFReader | Each unit of data is a image file (TIFF) inside the root folder | Lexigraphical order | minerva.data.readers.tiff_reader.TiffReader | File extensions: .tif and .tiff |
| TabularReader | Each unit of data is the i-th row in a dataframe, with columns filtered | Dataframe rows | minerva.data.readers.tabular_reader.TabularReader | Support pandas dataframe |
| CSVReader | Each unit of data is the i-th row in a CSV file, with columns filtered | CSV Rowd | minerva.data.readers.csv_reader.CSVReader | If dataframe is already open, use TabularReader instead. This class will open and load the CSV file and pass it to a TabularReader |
| PatchedArrayReader | Each unit of data is a submatrix of specified shape inside an n-dimensional array | Dimension order | minerva.data.readers.patched_array_reader.PatchedArrayReader | Supports any data with ndarray protocol (tensor, xarray, zarr) |
| PatchedZarrReader | Each unit of data is a submatrix of specified shape inside an Zarr Array | Dimension order | minerva.data.readers.zarr_reader.ZarrArrayReader | Open zarr file in lazy mode and pass it to PatchedArrayReader |
## Readers

| **Reader** | **Data Unit** | **Order** | **Class** | **Observations** |
| :----------------- | ---------------------------------------------------------------------------------- | :-------------------: | :----------------: | ----------------------------------------------------------------------------------------------------------------------------------- |
| PNGReader | Each unit of data is a image file (PNG) inside the root folder | Lexicographical order | PNGReader | File extensions: .png |
| TIFFReader | Each unit of data is a image file (TIFF) inside the root folder | Lexicographical order | TiffReader | File extensions: .tif and .tiff |
| TabularReader | Each unit of data is the i-th row in a dataframe, with columns filtered | Dataframe rows | TabularReader | Support pandas dataframe |
| CSVReader | Each unit of data is the i-th row in a CSV file, with columns filtered | CSV Rowd | CSVReader | If data frame is already open, use TabularReader instead. This class will open and load the CSV file and pass it to a TabularReader |
| PatchedArrayReader | Each unit of data is a sub matrix of specified shape inside an n-dimensional array | Dimension order | PatchedArrayReader | Supports any data with ndarray protocol (tensor, xarray, zarr) |
| PatchedZarrReader | Each unit of data is a sub matrix of specified shape inside an Zarr Array | Dimension order | ZarrArrayReader | Open zarr file in lazy mode and pass it to PatchedArrayReader |

0 comments on commit 5ad6b60

Please sign in to comment.