pub struct CompatibilityGuarantees;
Expand description
API compatibility guarantees
This structure documents the compatibility guarantees for different components of the scirs2-datasets crate.
Implementations§
Source§impl CompatibilityGuarantees
impl CompatibilityGuarantees
Sourcepub const CORE_API_STABLE: &'static str = "
The following APIs are considered stable and will maintain backward compatibility:
- Dataset struct and its public methods (n_samples, n_features, etc.)
- Toy dataset loaders (load_iris, load_boston, load_breast_cancer, etc.)
- Core data generators (make_classification, make_regression, make_blobs, etc.)
- Cross-validation utilities (k_fold_split, stratified_k_fold_split, etc.)
- Basic dataset utilities (train_test_split, normalize_features, etc.)
- Error types and Result definitions
"
pub const CORE_API_STABLE: &'static str = " The following APIs are considered stable and will maintain backward compatibility: - Dataset struct and its public methods (n_samples, n_features, etc.) - Toy dataset loaders (load_iris, load_boston, load_breast_cancer, etc.) - Core data generators (make_classification, make_regression, make_blobs, etc.) - Cross-validation utilities (k_fold_split, stratified_k_fold_split, etc.) - Basic dataset utilities (train_test_split, normalize_features, etc.) - Error types and Result definitions "
Core dataset types and basic operations
These are considered stable and will maintain backward compatibility:
Dataset
struct and its public methods- Basic dataset loading functions (
load_iris
,load_boston
, etc.) - Core data generation functions (
make_classification
,make_regression
, etc.) - Cross-validation utilities
- Basic dataset manipulation functions
Sourcepub const EXPERIMENTAL_API: &'static str = "
The following APIs are experimental and may change in minor versions:
- GPU acceleration (gpu module)
- Cloud storage integration (cloud module)
- Distributed processing (distributed module)
- Advanced ML pipeline features (ml_integration advanced features)
- Domain-specific datasets (domain_specific module)
- Streaming dataset processing (streaming module)
- Advanced data generators (advanced_generators module)
"
pub const EXPERIMENTAL_API: &'static str = " The following APIs are experimental and may change in minor versions: - GPU acceleration (gpu module) - Cloud storage integration (cloud module) - Distributed processing (distributed module) - Advanced ML pipeline features (ml_integration advanced features) - Domain-specific datasets (domain_specific module) - Streaming dataset processing (streaming module) - Advanced data generators (advanced_generators module) "
Advanced features that are experimental
These features may change in minor versions:
- GPU acceleration APIs
- Cloud storage integration
- Distributed processing
- Advanced ML pipeline integration
- Domain-specific datasets
Sourcepub const INTERNAL_API: &'static str = "
The following APIs are internal and may change without notice:
- Cache implementation details
- Internal registry structures
- Private utility functions
- Internal error handling mechanisms
- Performance optimization internals
"
pub const INTERNAL_API: &'static str = " The following APIs are internal and may change without notice: - Cache implementation details - Internal registry structures - Private utility functions - Internal error handling mechanisms - Performance optimization internals "
Internal APIs that may change without notice
These are not part of the public API:
- Cache implementation details
- Internal data structures
- Private utility functions
Auto Trait Implementations§
impl Freeze for CompatibilityGuarantees
impl RefUnwindSafe for CompatibilityGuarantees
impl Send for CompatibilityGuarantees
impl Sync for CompatibilityGuarantees
impl Unpin for CompatibilityGuarantees
impl UnwindSafe for CompatibilityGuarantees
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.