-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(samples): add create-featurestore samples (#317)
* added create-featurestore-sample.js and create-featurestore-sample.test.js * feat(samples): added createFeaturestore sample (#313) * feat(samples): added remaining featurestore samples (#313) * removed the extraneous files * feat(samples): added create-featurestore sample (#313) * feat(samples): added variation of create-featurestore sample (#313) * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
1 parent
3012345
commit 28c3182
Showing
4 changed files
with
331 additions
and
0 deletions.
There are no files selected for viewing
94 changes: 94 additions & 0 deletions
94
ai-platform/snippets/create-featurestore-fixed-nodes-sample.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
/* | ||
* Copyright 2022 Google LLC | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
/* | ||
* Creates a new Featurestore with fixed nodes configuration in a given project and location. | ||
* See https://cloud.google.com/vertex-ai/docs/featurestore/setup before running | ||
* the code snippet | ||
*/ | ||
|
||
'use strict'; | ||
|
||
async function main( | ||
project, | ||
featurestoreId, | ||
fixedNodeCount = 1, | ||
location = 'us-central1', | ||
apiEndpoint = 'us-central1-aiplatform.googleapis.com', | ||
timeout = 900000 | ||
) { | ||
// [START aiplatform_create_featurestore_fixed_nodes_sample] | ||
/** | ||
* TODO(developer): Uncomment these variables before running the sample.\ | ||
* (Not necessary if passing values as arguments) | ||
*/ | ||
|
||
// const project = 'YOUR_PROJECT_ID'; | ||
// const featurestoreId = 'YOUR_FEATURESTORE_ID'; | ||
// const fixedNodeCount = <NO_OF_NODES>; | ||
// const location = 'YOUR_PROJECT_LOCATION'; | ||
// const apiEndpoint = 'YOUR_API_ENDPOINT'; | ||
// const timeout = <TIMEOUT_IN_MILLI_SECONDS>; | ||
|
||
// Imports the Google Cloud Featurestore Service Client library | ||
const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; | ||
|
||
// Specifies the location of the api endpoint | ||
const clientOptions = { | ||
apiEndpoint: apiEndpoint, | ||
}; | ||
|
||
// Instantiates a client | ||
const featurestoreServiceClient = new FeaturestoreServiceClient( | ||
clientOptions | ||
); | ||
|
||
async function createFeaturestoreFixedNodes() { | ||
// Configure the parent resource | ||
const parent = `projects/${project}/locations/${location}`; | ||
|
||
const featurestore = { | ||
onlineServingConfig: {fixedNodeCount: Number(fixedNodeCount)}, | ||
}; | ||
|
||
const request = { | ||
parent: parent, | ||
featurestore: featurestore, | ||
featurestoreId: featurestoreId, | ||
}; | ||
|
||
// Create Featurestore request | ||
const [operation] = await featurestoreServiceClient.createFeaturestore( | ||
request, | ||
{timeout: Number(timeout)} | ||
); | ||
const [response] = await operation.promise(); | ||
|
||
console.log('Create featurestore fixed nodes response'); | ||
console.log(`Name : ${response.name}`); | ||
console.log('Raw response:'); | ||
console.log(JSON.stringify(response, null, 2)); | ||
} | ||
createFeaturestoreFixedNodes(); | ||
// [END aiplatform_create_featurestore_fixed_nodes_sample] | ||
} | ||
|
||
process.on('unhandledRejection', err => { | ||
console.error(err.message); | ||
process.exitCode = 1; | ||
}); | ||
|
||
main(...process.argv.slice(2)); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
/* | ||
* Copyright 2022 Google LLC | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
/* | ||
* Creates a new Featurestore in a given project and location. | ||
* See https://cloud.google.com/vertex-ai/docs/featurestore/setup before running | ||
* the code snippet | ||
*/ | ||
|
||
'use strict'; | ||
|
||
async function main( | ||
project, | ||
featurestoreId, | ||
minNodeCount = 1, | ||
maxNodeCount = 5, | ||
location = 'us-central1', | ||
apiEndpoint = 'us-central1-aiplatform.googleapis.com', | ||
timeout = 900000 | ||
) { | ||
// [START aiplatform_create_featurestore_sample] | ||
/** | ||
* TODO(developer): Uncomment these variables before running the sample.\ | ||
* (Not necessary if passing values as arguments) | ||
*/ | ||
|
||
// const project = 'YOUR_PROJECT_ID'; | ||
// const featurestoreId = 'YOUR_FEATURESTORE_ID'; | ||
// const minNodeCount = <MINIMUM_NO_OF_NODES>; | ||
// const maxNodeCount = <MAXIMUM_NO_OF_NODES>; | ||
// const location = 'YOUR_PROJECT_LOCATION'; | ||
// const apiEndpoint = 'YOUR_API_ENDPOINT'; | ||
// const timeout = <TIMEOUT_IN_MILLI_SECONDS>; | ||
|
||
// Imports the Google Cloud Featurestore Service Client library | ||
const {FeaturestoreServiceClient} = | ||
require('@google-cloud/aiplatform').v1beta1; | ||
|
||
// Specifies the location of the api endpoint | ||
const clientOptions = { | ||
apiEndpoint: apiEndpoint, | ||
}; | ||
|
||
// Instantiates a client | ||
const featurestoreServiceClient = new FeaturestoreServiceClient( | ||
clientOptions | ||
); | ||
|
||
async function createFeaturestore() { | ||
// Configure the parent resource | ||
const parent = `projects/${project}/locations/${location}`; | ||
|
||
const featurestore = { | ||
onlineServingConfig: { | ||
scaling: { | ||
minNodeCount: minNodeCount, | ||
maxNodeCount: maxNodeCount, | ||
}, | ||
}, | ||
}; | ||
|
||
const request = { | ||
parent: parent, | ||
featurestore: featurestore, | ||
featurestoreId: featurestoreId, | ||
}; | ||
|
||
// Create Featurestore request | ||
const [operation] = await featurestoreServiceClient.createFeaturestore( | ||
request, | ||
{timeout: Number(timeout)} | ||
); | ||
const [response] = await operation.promise(); | ||
|
||
console.log('Create featurestore response'); | ||
console.log(`Name : ${response.name}`); | ||
console.log('Raw response:'); | ||
console.log(JSON.stringify(response, null, 2)); | ||
} | ||
createFeaturestore(); | ||
// [END aiplatform_create_featurestore_sample] | ||
} | ||
|
||
process.on('unhandledRejection', err => { | ||
console.error(err.message); | ||
process.exitCode = 1; | ||
}); | ||
|
||
main(...process.argv.slice(2)); |
67 changes: 67 additions & 0 deletions
67
ai-platform/snippets/test/create-featurestore-fixed-nodes-sample.test.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
/* | ||
* Copyright 2022 Google LLC | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
'use strict'; | ||
|
||
const {assert} = require('chai'); | ||
const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; | ||
const {after, describe, it} = require('mocha'); | ||
const uuid = require('uuid').v4; | ||
const cp = require('child_process'); | ||
const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'}); | ||
|
||
const project = process.env.CAIP_PROJECT_ID; | ||
const featurestoreId = `featurestore_sample_${uuid() | ||
.replace(/-/g, '_') | ||
.slice(10, 20)}`; | ||
const fixedNodeCount = 1; | ||
const location = 'us-central1'; | ||
const apiEndpoint = 'us-central1-aiplatform.googleapis.com'; | ||
|
||
// Instantiates a featurestore clients | ||
const featurestoreServiceClient = new FeaturestoreServiceClient({ | ||
apiEndpoint: apiEndpoint, | ||
}); | ||
|
||
const deleteFeaturestore = async () => { | ||
// Configure the name resource | ||
const name = `projects/${project}/locations/${location}/featurestores/${featurestoreId}`; | ||
|
||
const request = { | ||
name: name, | ||
force: true, | ||
}; | ||
|
||
// Delete Featurestore request | ||
const [operation] = await featurestoreServiceClient.deleteFeaturestore( | ||
request, | ||
{timeout: 60000} | ||
); | ||
await operation.promise(); | ||
}; | ||
|
||
describe('AI platform create featurestore with fixed nodes', async function () { | ||
this.retries(2); | ||
it('should create a featurestore', async () => { | ||
const stdout = execSync( | ||
`node ./create-featurestore-fixed-nodes-sample.js ${project} ${featurestoreId} ${fixedNodeCount} ${location} ${apiEndpoint}` | ||
); | ||
assert.match(stdout, /Create featurestore fixed nodes response/); | ||
}); | ||
after('should delete the created featurestore', async () => { | ||
await deleteFeaturestore(); | ||
}); | ||
}); |
68 changes: 68 additions & 0 deletions
68
ai-platform/snippets/test/create-featurestore-sample.test.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
/* | ||
* Copyright 2022 Google LLC | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
'use strict'; | ||
|
||
const {assert} = require('chai'); | ||
const {FeaturestoreServiceClient} = require('@google-cloud/aiplatform').v1; | ||
const {after, describe, it} = require('mocha'); | ||
const uuid = require('uuid').v4; | ||
const cp = require('child_process'); | ||
const execSync = cmd => cp.execSync(cmd, {encoding: 'utf-8'}); | ||
|
||
const project = process.env.CAIP_PROJECT_ID; | ||
const featurestoreId = `featurestore_sample_${uuid() | ||
.replace(/-/g, '_') | ||
.slice(10, 20)}`; | ||
const minNodeCount = 1; | ||
const maxNodeCount = 5; | ||
const location = 'us-central1'; | ||
const apiEndpoint = 'us-central1-aiplatform.googleapis.com'; | ||
|
||
// Instantiates a featurestore clients | ||
const featurestoreServiceClient = new FeaturestoreServiceClient({ | ||
apiEndpoint: apiEndpoint, | ||
}); | ||
|
||
const deleteFeaturestore = async () => { | ||
// Configure the name resource | ||
const name = `projects/${project}/locations/${location}/featurestores/${featurestoreId}`; | ||
|
||
const request = { | ||
name: name, | ||
force: true, | ||
}; | ||
|
||
// Delete Featurestore request | ||
const [operation] = await featurestoreServiceClient.deleteFeaturestore( | ||
request, | ||
{timeout: 60000} | ||
); | ||
await operation.promise(); | ||
}; | ||
|
||
describe('AI platform create featurestore', async function () { | ||
this.retries(2); | ||
it('should create a featurestore', async () => { | ||
const stdout = execSync( | ||
`node ./create-featurestore-sample.js ${project} ${featurestoreId} ${minNodeCount} ${maxNodeCount} ${location} ${apiEndpoint}` | ||
); | ||
assert.match(stdout, /Create featurestore response/); | ||
}); | ||
after('should delete the created featurestore', async () => { | ||
await deleteFeaturestore(); | ||
}); | ||
}); |