UNPKG

1.5 kBTypeScriptView Raw
1/**
2 * @license
3 * Copyright 2020 Google Inc. All Rights Reserved.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 * =============================================================================
16 */
17/// <amd-module name="@tensorflow/tfjs-core/dist/ops/log_softmax" />
18import { Tensor } from '../tensor';
19import { TensorLike } from '../types';
20/**
21 * Computes the log softmax.
22 *
23 * ```js
24 * const a = tf.tensor1d([1, 2, 3]);
25 *
26 * a.logSoftmax().print(); // or tf.logSoftmax(a)
27 * ```
28 *
29 * ```js
30 * const a = tf.tensor2d([2, 4, 6, 1, 2, 3], [2, 3]);
31 *
32 * a.logSoftmax().print(); // or tf.logSoftmax(a)
33 * ```
34 *
35 * @param logits The logits array.
36 * @param axis The dimension softmax would be performed on. Defaults to `-1`
37 * which indicates the last dimension.
38 *
39 * @doc {heading: 'Operations', subheading: 'Normalization'}
40 */
41declare function logSoftmax_<T extends Tensor>(logits: T | TensorLike, axis?: number): T;
42export declare const logSoftmax: typeof logSoftmax_;
43export {};