You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/concepts/overview.md
+28-7Lines changed: 28 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,10 @@
4
4
5
5
SiaPy follows a modular architecture organized around key components that work together to provide a comprehensive toolkit for spectral image analysis.
6
6
7
-
### Core (`siapy.core`)
7
+
### Core
8
+
9
+
??? note "API Documentation"
10
+
`siapy.core`
8
11
9
12
The foundation of the library providing essential functionality:
10
13
@@ -13,7 +16,10 @@ The foundation of the library providing essential functionality:
13
16
-**Type definitions**: Common types used throughout the library
14
17
-**Configuration**: System paths and global configuration settings
15
18
16
-
### Entities (`siapy.entities`)
19
+
### Entities
20
+
21
+
??? note "API Documentation"
22
+
`siapy.entities`
17
23
18
24
Fundamental data structures that represent spectral imaging data:
19
25
@@ -23,34 +29,49 @@ Fundamental data structures that represent spectral imaging data:
23
29
-**Shapes**: Geometric shapes for images' regions selection and masking
24
30
-**Signatures**: Spectral signatures extracted from images
25
31
26
-
### Datasets (`siapy.datasets`)
32
+
### Datasets
33
+
34
+
??? note "API Documentation"
35
+
`siapy.datasets`
27
36
28
37
Tools for managing and working with datasets:
29
38
30
39
-**Tabular datasets**: Handling tabular data with spectral information
31
40
32
-
### Features (`siapy.features`)
41
+
### Features
42
+
43
+
??? note "API Documentation"
44
+
`siapy.features`
33
45
34
46
Functionality for working with spectral features:
35
47
36
48
-**Features**: Abstractions for feature extraction and selection
37
49
-**Spectral indices**: Calculation of various spectral indices
38
50
39
-
### Transformations (`siapy.transformations`)
51
+
### Transformations
52
+
53
+
??? note "API Documentation"
54
+
`siapy.transformations`
40
55
41
56
Transformation capabilities:
42
57
43
58
-**Co-registration**: Aligning images from different sources
44
59
-**Image processing**: Functions for image manipulation
45
60
46
-
### Optimizers (`siapy.optimizers`)
61
+
### Optimizers
62
+
63
+
??? note "API Documentation"
64
+
`siapy.optimizers`
47
65
48
66
Optimization, hyperparameter tuning and evaluation:
49
67
50
68
-**Optimization**: Machine learning training and optimization of hyperparameters
51
69
-**Evaluation metrics and scoring mechanisms**: Tools for assessing model performance
0 commit comments