Diff of /docs-source/source/io.rst [000000] .. [78ef36]

Switch to unified view

a b/docs-source/source/io.rst
1
.. currentmodule:: slideflow.io
2
3
slideflow.io
4
============
5
6
This module contains utility functions for working with TFRecords, cross-compatible
7
with both Tensorflow and PyTorch.
8
9
Functions included in this module assist with processing TFRecords, detecting image and data format,
10
extracting tiles, splitting and merging TFrecords, and a variety of other manipulations.
11
12
Additional Tensorflow-specific TFRecord reading/writing utility functions are
13
available in :py:mod:`slideflow.io.tensorflow`, and additional PyTorch-specific
14
functions are in :py:mod:`slideflow.io.torch`.
15
16
.. autofunction:: convert_dtype
17
.. autofunction:: detect_tfrecord_format
18
.. autofunction:: extract_tiles
19
.. autofunction:: get_locations_from_tfrecord
20
.. autofunction:: get_tfrecord_by_index
21
.. autofunction:: get_tfrecord_by_location
22
.. autofunction:: get_tfrecord_parser
23
.. autofunction:: get_tfrecord_length
24
.. autofunction:: read_and_return_record
25
.. autofunction:: serialized_record
26
.. autofunction:: tfrecord_has_locations
27
.. autofunction:: update_manifest_at_dir
28
.. autofunction:: write_tfrecords_multi
29
.. autofunction:: write_tfrecords_single
30
.. autofunction:: write_tfrecords_merge
31
32
slideflow.io.preservedsite
33
**************************
34
.. autofunction:: slideflow.io.preservedsite.generate_crossfolds