Preface¶

Repository Setup¶

This repository provides an end-to-end template for AI Singapore's AI engineers to onboard their AI projects. Instructions for generating this template is detailed in the cookiecutter template's repository's README.md .

While this repository provides users with a set of boilerplates, here you are also presented with a linear guide on how to use them. The boilerplates are rendered and customised when you generated this repository using cruft.

Since we will be making use of this repository in multiple environments, ensure that this repository is pushed to a remote. Most probably you will be resorting to AI Singapore's GitLab instance as the remote. Refer to here on creating a blank remote repository (or project in GitLab's term). After creating the remote repository, retrieve the remote URL and push the local repository to remote:

$ git init
$ git remote add origin <REMOTE_URL>
$ git add .
$ git config user.email "<YOUR_AISG_EMAIL>"
$ git config user.name "<YOUR_NAME>"
$ git commit -m "Initial commit."
$ git push -u origin master

Guide's Problem Statement¶

For this guide, we will work towards building a predictive model that is able to conduct sentiment classification for movie reviews. The model is then to be deployed through a REST API and used for batch inferencing as well. The raw dataset to be used is obtainable through a GCS bucket; instructions for downloading the data into your development environment are detailed under "Data Storage & Versioning", to be referred to later on.

Google Cloud Platform (GCP) Projects¶

Each project in AI Singapore that requires the usage of GCP resources would be provided with a GCP project. Such projects are accessible through the GCP console once you've logged into your AI Singapore Google account.

Authorisation¶

You can use GCP's Cloud SDK to interact with the varying GCP services. When you're using the SDK for the first time, you are to provide authorisation using a user or service account. In AI Singapore's context, unless your use case concerns some automation or CI/CD pipelines, you will probably be using your user account (i.e. Google accounts with AI Singapore domains such as @aisingapore.org or @aiap.sg). See here for more information on authorising your SDK.

A simple command to authorise access:

$ gcloud auth login

To register gcloud for Docker so you can push to Google Container Registry:

$ gcloud auth configure-docker

With your user account, you should have access to the following GCP products/services:

• Kubernetes Engine (GKE)
• Cloud Storage (GCS)
• Container Registry (GCR)