Skip to main content

Integration Tips & Recommendations

Resource naming conventions​

Resource names​

  • Must be unique within a namespace (datasets, models, sources, secrets, and training jobs)
  • Must be between 3 and 63 characters long.
  • Must be composed of lowercase alphanumeric characters.
  • Can only contain hyphens (-) and underscores (_) as special characters.
  • Must start and end with an alphanumeric character.

Environment Variables & Secrets - Keys​

Environment Variables and Secrets that are passed to a training job execution have two components: a Key and a Value: -E .is_testing-env=true, -S HF_TOKEN=hf, -E _EPOCHS=500 -S WANDB_API_KEY=wandb_prod

Keys must follow the conventions below:

  • Must be at least 1 character long.
  • Must start with a letter (lowercase or uppercase), a hyphen (-), an underscore (_), or a period (.).
  • Can be composed of (and end with) lowercase or uppercase characters, numbers, hyphens (-), underscores (_), or periods (.).
  • Must be unique within a training job execution (the rightmost one will take precedence).

Logging in from a non-graphical environment​

The FlexAI Cloud Services (FCS) CLI does not currently support directly logging in from a virtual non-graphical environment, such as a Virtual Machine (VM) instance. This is because the CLI requires a web browser to authenticate the user through their GitHub account.

There is however a workaround to this current limitation: You can install the FCS CLI on a machine equipped with a web browser, log in using the flexai auth login command and then copy the FCS CLI configuration file contents to the VM's $HOME/.flexai/config.yaml configuration file:

  1. Log into FCS from a machine equipped with a web browser
  2. Open the $HOME/.flexai/config.yaml file on that machine
  3. Copy its contents
  4. Open the $HOME/.flexai/config.yaml file on your machine without a graphical environment
  5. Paste the contents of the first configuration file into the second one

Running the FlexAI CLI on a local VM or Container​

If the environment you're using to run the FCS CLI is a local VM or container, you can set-up your environment to use host networking to allow the FCS CLI to get the authentication callback message from your host system.

References​