Skip to content

Commit e2ae548

Browse files
committed
docs: add API documentation notes for core components in overview.md
1 parent d25cdfb commit e2ae548

1 file changed

Lines changed: 28 additions & 7 deletions

File tree

docs/concepts/overview.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44

55
SiaPy follows a modular architecture organized around key components that work together to provide a comprehensive toolkit for spectral image analysis.
66

7-
### Core (`siapy.core`)
7+
### Core
8+
9+
??? note "API Documentation"
10+
`siapy.core`
811

912
The foundation of the library providing essential functionality:
1013

@@ -13,7 +16,10 @@ The foundation of the library providing essential functionality:
1316
- **Type definitions**: Common types used throughout the library
1417
- **Configuration**: System paths and global configuration settings
1518

16-
### Entities (`siapy.entities`)
19+
### Entities
20+
21+
??? note "API Documentation"
22+
`siapy.entities`
1723

1824
Fundamental data structures that represent spectral imaging data:
1925

@@ -23,34 +29,49 @@ Fundamental data structures that represent spectral imaging data:
2329
- **Shapes**: Geometric shapes for images' regions selection and masking
2430
- **Signatures**: Spectral signatures extracted from images
2531

26-
### Datasets (`siapy.datasets`)
32+
### Datasets
33+
34+
??? note "API Documentation"
35+
`siapy.datasets`
2736

2837
Tools for managing and working with datasets:
2938

3039
- **Tabular datasets**: Handling tabular data with spectral information
3140

32-
### Features (`siapy.features`)
41+
### Features
42+
43+
??? note "API Documentation"
44+
`siapy.features`
3345

3446
Functionality for working with spectral features:
3547

3648
- **Features**: Abstractions for feature extraction and selection
3749
- **Spectral indices**: Calculation of various spectral indices
3850

39-
### Transformations (`siapy.transformations`)
51+
### Transformations
52+
53+
??? note "API Documentation"
54+
`siapy.transformations`
4055

4156
Transformation capabilities:
4257

4358
- **Co-registration**: Aligning images from different sources
4459
- **Image processing**: Functions for image manipulation
4560

46-
### Optimizers (`siapy.optimizers`)
61+
### Optimizers
62+
63+
??? note "API Documentation"
64+
`siapy.optimizers`
4765

4866
Optimization, hyperparameter tuning and evaluation:
4967

5068
- **Optimization**: Machine learning training and optimization of hyperparameters
5169
- **Evaluation metrics and scoring mechanisms**: Tools for assessing model performance
5270

53-
### Utils (`siapy.utils`)
71+
### Utils
72+
73+
??? note "API Documentation"
74+
`siapy.utils`
5475

5576
Utility and plotting functions:
5677

0 commit comments

Comments
 (0)