# shrinkage::CrossValidation

Shrinkage for Rust · 0.3.0

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

```rust
pub struct CrossValidation
```

Validated folds, held-out metric, and selection policy. 

<a id="impl-292c34c4c2d13391b46c7a545c5d0cbfec8cb70a4342d8325c18a157b37993a5"></a>

## Inherent implementation

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

```rust
impl CrossValidation
```

<a id="method-folds-292c34c4c2d13391b46c7a545c5d0cbfec8cb70a4342d8325c18a157b37993a5"></a>

### `folds`

```rust
pub fn folds(&self) -> &FoldAssignments
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

Borrow the reproducible fold assignments. 

<a id="method-metric-292c34c4c2d13391b46c7a545c5d0cbfec8cb70a4342d8325c18a157b37993a5"></a>

### `metric`

```rust
pub fn metric(self, metric: ValidationMetric) -> Self
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

Override the family's default held-out metric, checked when fitting. 

<a id="method-new-292c34c4c2d13391b46c7a545c5d0cbfec8cb70a4342d8325c18a157b37993a5"></a>

### `new`

```rust
pub fn new(folds: FoldAssignments) -> Self
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

Use supplied folds, the family's default metric, and minimum-error selection. 

<a id="method-selection_rule-292c34c4c2d13391b46c7a545c5d0cbfec8cb70a4342d8325c18a157b37993a5"></a>

### `selection_rule`

```rust
pub fn selection_rule(self, rule: SelectionRule) -> Self
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

Choose minimum error or the one-standard-error preference rule. 

<a id="impl-1fcd63db0bfe7e98abdc6514a19976d689b27ffe395a17ddb0617a4be6b5d3c1"></a>

## Implementation of Clone

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

```rust
impl Clone for CrossValidation
```

<a id="method-clone-1fcd63db0bfe7e98abdc6514a19976d689b27ffe395a17ddb0617a4be6b5d3c1"></a>

### `clone`

```rust
fn clone(&self) -> Self
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

<a id="impl-a8a283d23d2120d2b363892bd761996dc1ef3a30283b9471bfc16d5265f40b85"></a>

## Implementation of Debug

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

```rust
impl Debug for CrossValidation
```

<a id="method-fmt-a8a283d23d2120d2b363892bd761996dc1ef3a30283b9471bfc16d5265f40b85"></a>

### `fmt`

```rust
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result
```

[Source](<https://github.com/jolars/shrinkage/blob/eeafe449edce19d3c552a03060f681ae3891af74/src/cross_validation.rs>)

<a id="impl-d53486b53c5acb6c03df264e7892da405bf6adc4decd78831e98afbd69b5f495"></a>

## Implementation of Freeze

```rust
impl Freeze for CrossValidation
```

<a id="impl-bdc3ceba30f6ce29d23c9b72cbad7834ce24d03c47cd51de65cbc489832071e7"></a>

## Implementation of RefUnwindSafe

```rust
impl RefUnwindSafe for CrossValidation
```

<a id="impl-818f0c117d28d9e5096dd5caa71d8136db48d4c409f298ea6e641569bc7a9693"></a>

## Implementation of Send

```rust
impl Send for CrossValidation
```

<a id="impl-137d40ac4629562c6eda3ab4a35eba06e765ba46609cfd33788d280499a82580"></a>

## Implementation of Sync

```rust
impl Sync for CrossValidation
```

<a id="impl-1b67cdca8972de0dcfba34ddc6165c172f84cf1b866eece38c5584551c5f15f8"></a>

## Implementation of Unpin

```rust
impl Unpin for CrossValidation
```

<a id="impl-615a266195dda89286ec3d88b0be5132d88e7fa8576444287c19d89119ef85a4"></a>

## Implementation of UnsafeUnpin

```rust
impl UnsafeUnpin for CrossValidation
```

<a id="impl-21595e754e4e3e863cb038df687fbb0887920a1afb00894658349f16f25a3527"></a>

## Implementation of UnwindSafe

```rust
impl UnwindSafe for CrossValidation
```

<a id="impl-1e5682dc18e03c648aa9b125290c107c1e8d96ce8a179a8532e4057da4daf0cd"></a>

## Implementation of Any

```rust
impl<T> Any for T where T: 'static + ?Sized
```

<a id="impl-6c0b25c2c92cdb117802d9c0a4c70afc9a8bfb0da875bc6e66191e2349fcdf3f"></a>

## Implementation of Borrow

```rust
impl<T> Borrow<T> for T where T: ?Sized
```

<a id="impl-796e80d926348273a22b04d8e84f510693b11c06ec57c3c3e2e8c1524094a85c"></a>

## Implementation of BorrowMut

```rust
impl<T> BorrowMut<T> for T where T: ?Sized
```

<a id="impl-8360e4092e7ec4a05a26dd304cd739398f0cacc50c8d08dd5be0223d1a08d02e"></a>

## Implementation of ByRef

```rust
impl<T> ByRef<T> for T
```

<a id="impl-dbb1293b7b5dd80c4d9a98cfdd6843dc7470224c0b1387731cd418da07046d7b"></a>

## Implementation of CastableFrom

```rust
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT where ST: ?Sized, DT: ?Sized
```

<a id="impl-97b65e7dfc44b5ecaa495a3a19fe737914a1e9f8532200cf8f46191314e7d777"></a>

## Implementation of CastableFrom

```rust
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT where ST: ?Sized, DT: ?Sized
```

<a id="impl-86d7da2bfd1140cc1675dfe6a975e6a2762338ab32731152da0723858ef3aa81"></a>

## Implementation of CloneToUninit

```rust
impl<T> CloneToUninit for T where T: Clone
```

<a id="impl-c22bdd3b1b677b66eb32d1c182cc1410c7f0c46491dd74e6a659647c238d19ec"></a>

## Implementation of From

```rust
impl<T> From<T> for T
```

<a id="impl-5adf6ca1830f30fbbac655ab8ff394d254954df7ededc7cc833c72fdc87d6f00"></a>

## Implementation of Imply

```rust
impl<T, U> Imply<T> for U where T: ?Sized, U: ?Sized
```

<a id="impl-85eec431edd188129f88290bbcb748e4d2fdc97f7efef3c162b8c252286ffec0"></a>

## Implementation of Into

```rust
impl<T, U> Into<U> for T where U: From<T>
```

<a id="impl-c40268dd59dd3329202d3c0544c62372e98ff3baa8ec442ec00752e024ec1d06"></a>

## Implementation of IntoEither

```rust
impl<T> IntoEither for T
```

<a id="impl-5655b1ef858b34a584cb80104f040c8a4063ced0d281311a0833ed12aefde86e"></a>

## Implementation of Pointable

```rust
impl<T> Pointable for T
```

<a id="impl-8cc2aa01198fc9fa44f08b889f62988d70d2a7f4f0f11f4666d4c08bdaddb22a"></a>

## Implementation of Read

```rust
impl<T> Read<Exclusive, BecauseExclusive> for T where T: ?Sized
```

<a id="impl-5ea09131039c62dd92b119d480a35c7e2b33d2b81dccf0b849f6b1f19f4bda24"></a>

## Implementation of Same

```rust
impl<T> Same for T
```

<a id="impl-7ee6ff38d6674f5edfe4734359062c2a67a572cff5899a89704764822b931c7f"></a>

## Implementation of SupersetOf

```rust
impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>
```

<a id="impl-a8ef6e94191301c3685488478f4905086c47137bac2d606ea4d09631d5472b06"></a>

## Implementation of ToOwned

```rust
impl<T> ToOwned for T where T: Clone
```

<a id="impl-83960135d00d98080c95a08867729696e36811280c2dd9cf34c1b4fe21c81e18"></a>

## Implementation of TryFrom

```rust
impl<T, U> TryFrom<U> for T where U: Into<T>
```

<a id="impl-1cc495bcaa5112ffb304e7f0de674feca391fd97f47bec86033a9225b72ac05c"></a>

## Implementation of TryInto

```rust
impl<T, U> TryInto<U> for T where U: TryFrom<T>
```