kibana/api_docs/ml.mdx
Stacey Gammon 6723fa583f
Add packages to our API documentation (#113564)
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
2021-10-06 17:02:57 -04:00

80 lines
1.9 KiB
Plaintext

---
id: kibMlPluginApi
slug: /kibana-dev-docs/api/ml
title: "ml"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the ml plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import mlObj from './ml.json';
This plugin provides access to the machine learning features provided by Elastic.
Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 282 | 10 | 278 | 33 |
## Client
### Start
<DocDefinitionList data={[mlObj.client.start]}/>
### Objects
<DocDefinitionList data={mlObj.client.objects}/>
### Functions
<DocDefinitionList data={mlObj.client.functions}/>
### Classes
<DocDefinitionList data={mlObj.client.classes}/>
### Interfaces
<DocDefinitionList data={mlObj.client.interfaces}/>
### Enums
<DocDefinitionList data={mlObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={mlObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[mlObj.server.setup]}/>
### Start
<DocDefinitionList data={[mlObj.server.start]}/>
### Functions
<DocDefinitionList data={mlObj.server.functions}/>
### Classes
<DocDefinitionList data={mlObj.server.classes}/>
### Interfaces
<DocDefinitionList data={mlObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={mlObj.server.misc}/>
## Common
### Objects
<DocDefinitionList data={mlObj.common.objects}/>
### Functions
<DocDefinitionList data={mlObj.common.functions}/>
### Enums
<DocDefinitionList data={mlObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={mlObj.common.misc}/>