.TH "GCLOUD_BETA_AI\-PLATFORM_EXPLAIN" 1



.SH "NAME"
.HP
gcloud beta ai\-platform explain \- run AI Platform explanation



.SH "SYNOPSIS"
.HP
\f5gcloud beta ai\-platform explain\fR \fB\-\-model\fR=\fIMODEL\fR (\fB\-\-json\-instances\fR=\fIJSON_INSTANCES\fR\ |\ \fB\-\-json\-request\fR=\fIJSON_REQUEST\fR\ |\ \fB\-\-text\-instances\fR=\fITEXT_INSTANCES\fR) [\fB\-\-region\fR=\fIREGION\fR] [\fB\-\-version\fR=\fIVERSION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR \f5gcloud beta ai\-platform explain\fR sends an explain request to
AI Platform for the given instances. This command will read up to 100 instances,
though the service itself will accept instances up to the payload limit size
(currently, 1.5MB).



.SH "EXAMPLES"

To get explanations for an AI Platform version model with the version 'version'
and with the name 'model\-name', run:

.RS 2m
$ gcloud beta ai\-platform explain explain \-\-model=model\-name \e
    \-\-version=version \-\-json\-instances=instances.json
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-model\fR=\fIMODEL\fR

Name of the model.

.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-json\-instances\fR=\fIJSON_INSTANCES\fR

Path to a local file from which instances are read. Instances are in JSON
format; newline delimited.

An example of the JSON instances file:

.RS 2m
{"images": [0.0, ..., 0.1], "key": 3}
{"images": [0.0, ..., 0.1], "key": 2}
...
.RE

This flag accepts "\-" for stdin.

.TP 2m
\fB\-\-json\-request\fR=\fIJSON_REQUEST\fR

Path to a local file containing the body of JSON request.

An example of a JSON request:

.RS 2m
{
  "instances": [
    {"x": [1, 2], "y": [3, 4]},
    {"x": [\-1, \-2], "y": [\-3, \-4]}
  ]
}
.RE

This flag accepts "\-" for stdin.

.TP 2m
\fB\-\-text\-instances\fR=\fITEXT_INSTANCES\fR

Path to a local file from which instances are read. Instances are in UTF\-8
encoded text format; newline delimited.

An example of the text instances file:

.RS 2m
107,4.9,2.5,4.5,1.7
100,5.7,2.8,4.1,1.3
...
.RE

This flag accepts "\-" for stdin.


.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-region\fR=\fIREGION\fR

Google Cloud region of the regional endpoint to use for this command. For the
global endpoint, the region needs to be specified as \f5global\fR.

Learn more about regional endpoints and see a list of available regions:
https://cloud.google.com/ai\-platform/prediction/docs/regional\-endpoints

\fIREGION\fR must be one of: \fBglobal\fR, \fBasia\-east1\fR,
\fBasia\-northeast1\fR, \fBasia\-southeast1\fR, \fBaustralia\-southeast1\fR,
\fBeurope\-west1\fR, \fBeurope\-west2\fR, \fBeurope\-west3\fR,
\fBeurope\-west4\fR, \fBnorthamerica\-northeast1\fR, \fBus\-central1\fR,
\fBus\-east1\fR, \fBus\-east4\fR, \fBus\-west1\fR.

.TP 2m
\fB\-\-version\fR=\fIVERSION\fR

Model version to be used.

If unspecified, the default version of the model will be used. To list model
versions run

.RS 2m
$ gcloud beta ai\-platform versions list
.RE


.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in beta and might change without notice. This variant
is also available:

.RS 2m
$ gcloud alpha ai\-platform explain
.RE