Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

change(ml): Deprecate AutoML model support #2013

Merged
merged 2 commits into from Dec 14, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions etc/firebase-admin.api.md
Expand Up @@ -320,6 +320,8 @@ export function machineLearning(app?: App): machineLearning.MachineLearning;
// @public (undocumented)
export namespace machineLearning {
// Warning: (ae-forgotten-export) The symbol "AutoMLTfliteModelOptions" needs to be exported by the entry point default-namespace.d.ts
//
// @deprecated
export type AutoMLTfliteModelOptions = AutoMLTfliteModelOptions;
// Warning: (ae-forgotten-export) The symbol "GcsTfliteModelOptions" needs to be exported by the entry point default-namespace.d.ts
export type GcsTfliteModelOptions = GcsTfliteModelOptions;
Expand Down
3 changes: 2 additions & 1 deletion etc/firebase-admin.machine-learning.api.md
Expand Up @@ -8,7 +8,7 @@

import { Agent } from 'http';

// @public (undocumented)
// @public @deprecated (undocumented)
export interface AutoMLTfliteModelOptions extends ModelOptionsBase {
// (undocumented)
tfliteModel: {
Expand Down Expand Up @@ -86,6 +86,7 @@ export interface ModelOptionsBase {

// @public
export interface TFLiteModel {
// @deprecated
readonly automlModel?: string;
readonly gcsTfliteUri?: string;
readonly sizeBytes: number;
Expand Down
3 changes: 3 additions & 0 deletions src/machine-learning/machine-learning-api-client.ts
Expand Up @@ -38,6 +38,9 @@ export interface GcsTfliteModelOptions extends ModelOptionsBase {
};
}

/**
* @deprecated AutoMLTfliteModelOptions will be removed in the next major version.
*/
export interface AutoMLTfliteModelOptions extends ModelOptionsBase {
tfliteModel: {
automlModel: string;
Expand Down
2 changes: 2 additions & 0 deletions src/machine-learning/machine-learning-namespace.ts
Expand Up @@ -82,6 +82,8 @@ export namespace machineLearning {

/**
* Type alias to {@link firebase-admin.machine-learning#AutoMLTfliteModelOptions}.
*
* @deprecated AutoMLTfliteModelOptions will be removed in the next major version.
*/
export type AutoMLTfliteModelOptions = TAutoMLTfliteModelOptions;

Expand Down
2 changes: 2 additions & 0 deletions src/machine-learning/machine-learning.ts
Expand Up @@ -53,6 +53,8 @@ export interface TFLiteModel {
/**
* The AutoML model reference from which the model was originally provided
* to Firebase.
*
* @deprecated AutoML model support will be removed in the next major version.
*/
readonly automlModel?: string;
}
Expand Down