documentation updates
This commit is contained in:
Родитель
da2d9923ac
Коммит
8768c9fbc6
|
@ -15,5 +15,6 @@ export interface SampleArgs
|
|||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [proportion?](./schema.sampleargs.proportion.md) | | number | <i>(Optional)</i> If table size is unknown ahead of time, specify a proportion of rows to sample. If size is specified, it will be used instead, otherwise computed from this proportion using the table.numRows() |
|
||||
| [seed?](./schema.sampleargs.seed.md) | | number | <i>(Optional)</i> The randomization seed to use for sampling to ensure stable sampling. This may not be supported in all environments. JS/Arquero do not support a seed value, however Pandas does. |
|
||||
| [size?](./schema.sampleargs.size.md) | | number | <i>(Optional)</i> Number of rows to sample from the table. This takes precedence over proportion. |
|
||||
|
||||
|
|
|
@ -0,0 +1,13 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [@datashaper/schema](./schema.md) > [SampleArgs](./schema.sampleargs.md) > [seed](./schema.sampleargs.seed.md)
|
||||
|
||||
## SampleArgs.seed property
|
||||
|
||||
The randomization seed to use for sampling to ensure stable sampling. This may not be supported in all environments. JS/Arquero do not support a seed value, however Pandas does.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
seed?: number;
|
||||
```
|
|
@ -8788,6 +8788,33 @@
|
|||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@datashaper/schema!SampleArgs#seed:member",
|
||||
"docComment": "/**\n * The randomization seed to use for sampling to ensure stable sampling. This may not be supported in all environments. JS/Arquero do not support a seed value, however Pandas does.\n */\n",
|
||||
"excerptTokens": [
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "seed?: "
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": "number"
|
||||
},
|
||||
{
|
||||
"kind": "Content",
|
||||
"text": ";"
|
||||
}
|
||||
],
|
||||
"isReadonly": false,
|
||||
"isOptional": true,
|
||||
"releaseTag": "Public",
|
||||
"name": "seed",
|
||||
"propertyTypeTokenRange": {
|
||||
"startIndex": 1,
|
||||
"endIndex": 2
|
||||
}
|
||||
},
|
||||
{
|
||||
"kind": "PropertySignature",
|
||||
"canonicalReference": "@datashaper/schema!SampleArgs#size:member",
|
||||
|
|
|
@ -892,6 +892,7 @@ export interface RollupArgs extends InputColumnArgs, OutputColumnArgs {
|
|||
// @public (undocumented)
|
||||
export interface SampleArgs {
|
||||
proportion?: number;
|
||||
seed?: number;
|
||||
size?: number;
|
||||
}
|
||||
|
||||
|
|
|
@ -478,7 +478,8 @@ export interface SampleArgs {
|
|||
proportion?: number
|
||||
|
||||
/**
|
||||
* The randomization seed to use for sampling to ensure stable sampling. May not be supported in all environments.
|
||||
* The randomization seed to use for sampling to ensure stable sampling.
|
||||
* This may not be supported in all environments. JS/Arquero do not support a seed value, however Pandas does.
|
||||
*/
|
||||
seed?: number
|
||||
}
|
||||
|
|
|
@ -950,6 +950,10 @@
|
|||
"description": "If table size is unknown ahead of time, specify a proportion of rows to sample.\nIf size is specified, it will be used instead, otherwise computed from this\nproportion using the table.numRows()",
|
||||
"type": "number"
|
||||
},
|
||||
"seed": {
|
||||
"description": "The randomization seed to use for sampling to ensure stable sampling.\nThis may not be supported in all environments. JS/Arquero do not support a seed value, however Pandas does.",
|
||||
"type": "number"
|
||||
},
|
||||
"size": {
|
||||
"description": "Number of rows to sample from the table.\nThis takes precedence over proportion.",
|
||||
"type": "number"
|
||||
|
|
Загрузка…
Ссылка в новой задаче