cSAXS/cdtools
0
0
Fork 0
mirror of https://github.com/cdtools-developers/cdtools.git synced 2026-10-02 23:02:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

Make edits to the docs to handle the lowercaseness of cdtools now

Browse Source
This commit is contained in:
Abe Levitan
2022-06-08 13:30:49 -07:00
parent 672096085b
commit 858d8f3b2a
5 changed files with 19 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/cdtools/datasets/__init__.py
+6 -4
View File
@@ -10,10 +10,7 @@ implemented by default in pytorch (such as drawing data in a random order,
drawing minibatches, etc.)
New Datasets can be defined a subclass of the main CDataset class defined
in the base.py file. Example implementations of all these functions
can be found in the code for the Ptycho2DDataset class. In addition, it is
recommended to read through the tutorial section on defining a new CDI
dataset before attempting to do so
in the base.py file, and should define the following functions:
* __init__
* __len__
@@ -23,6 +20,11 @@ dataset before attempting to do so
* to_cxi
* inspect
Example implementations of all these functions can be found in the code
for the Ptycho2DDataset class. In addition, it is recommended to read
through the tutorial section on defining a new CDI dataset before
attempting to do so
"""
# I don't believe that __all__ really needed, but it's nice to define it