Skip to content

airt ds

Usage:

$ airt ds [OPTIONS] COMMAND [ARGS]...

Options:

  • --install-completion: Install completion for the current shell.
  • --show-completion: Show completion for the current shell, to copy it or customize the installation.
  • --help: Show this message and exit.

Commands:

  • db: Creates an object that encapsulates the data...
  • details: Return metadata of the given data source.
  • dtypes: Return the dtype of each column for the given...
  • head: Return first few records for the given data...
  • local: Pull the data source from your local machine to airt server.
  • ls: List available data sources.
  • push: Push the prediction results into the target...
  • rm: Remove the data source from airt service.
  • s3: Pull the data source from a S3 bucket to airt...
  • tag: Tag an existing datasource in airt service.
  • train: Train a ML model for the given data source.

airt ds db

Creates an object that encapsulates the data from a database.

Usage:

$ airt ds db [OPTIONS]

Options:

  • --host TEXT: The name of the remote database host machine. [required]
  • --database TEXT: The logical name of the database to establish the connection. [required]
  • --table TEXT: The name of the table in the database. [required]
  • --port INTEGER: The port for the database server. If the value is not passed then the default port number will be used (e.g. for MySQL, 3306 will be used) [default: 3306]
  • --engine TEXT: The name of the database engine. If the value is not passed then the default database engine for MySQL will be used. [default: mysql]
  • -u, --username TEXT: A valid database user name. If not set (default value root), it will try to use the value from environment variable AIRT_CLIENT_DB_USERNAME.
  • -p, --password TEXT: The password for the specified user. If not set (default value ), it will try to use the value from environment variable AIRT_CLIENT_DB_PASSWORD.
  • --tag TEXT: The tag name for the data source. If None (default value), then the tag latest will be assigned to the data source.
  • -q, --quiet: Output data id only. [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt ds details

Return metadata of the given data source.

Usage:

$ airt ds details [OPTIONS] ID

Arguments:

  • ID: The data ID in the airt service. [required]

Options:

  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt ds dtypes

Return the dtype of each column for the given data source.

Usage:

$ airt ds dtypes [OPTIONS] ID

Arguments:

  • ID: The data ID in the airt service. [required]

Options:

  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt ds head

Return first few records for the given data ID.

Usage:

$ airt ds head [OPTIONS] ID

Arguments:

  • ID: The data ID in the airt service. [required]

Options:

  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt ds local

Pull the data source from your local machine to airt server. Currently, we support reading and pushing the data from a CSV file. We plan to support more data source formats in the future.

Usage:

$ airt ds local [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • csv: Pull the data source from a local CSV file to...

airt ds local csv

Pull the data source from a local CSV file to airt server.

Usage:

$ airt ds local csv [OPTIONS]

Options:

  • -f, --file_path TEXT: The relative or absolute path of the csv file. [required]
  • -i, --index_column TEXT: The Column name to use as the row labels. [required]
  • -s, --sort_by TEXT: The Column name to sort the data. [required]
  • -t, --tag_name TEXT: The tag name for the datasource.
  • -dd, --deduplicate_data: A boolean flag to handle the duplicate rows in the CSV file. If set to True (default value False), the duplicate rows will be removed from the CSV file before uploading to airt server. [default: False]
  • -bs, --blocksize TEXT: The number of bytes by which to cut up larger files. If None, the default value 256MB will be used for each file. [default: 256MB]
  • -json, --kwargs_json TEXT: Any additional parameters for Pandas read_csv method as a JSON string.
  • -q, --quiet: Output data id only. [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt ds ls

List available data sources.

Usage:

$ airt ds ls [OPTIONS]

Options:

  • -o, --offset INTEGER: The number of records to offset at the beginning of the datasource list. If None, then the default value 0 will be used. [default: 0]
  • -l, --limit INTEGER: The maximum number of records to return from the server. If None, then the default value 100 will be used. [default: 100]
  • --disabled: If set to True, then only the deleted datasources will be displayed. Else, the default value False will be used to display only the list of active datasources. [default: False]
  • -q, --quiet: Output only ids of datasource separated by space [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt ds push

Push the prediction results into the target data source.

Usage:

$ airt ds push [OPTIONS]

Options:

  • --data INTEGER: The data ID in the airt service. [required]
  • --pred INTEGER: The prediction ID in the airt service. [required]
  • -q, --quiet: Output the pushed prediction id only. [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt ds rm

Remove the data source from airt service.

Usage:

$ airt ds rm [OPTIONS] ID

Arguments:

  • ID: The data ID in the airt service. [required]

Options:

  • -q, --quiet: Output the deleted data id only. [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt ds s3

Pull the data source from a S3 bucket to airt server.

Usage:

$ airt ds s3 [OPTIONS] URI

Arguments:

  • URI: The AWS S3 bucket location of the Parquet files as a string. [required]

Options:

  • --access-key TEXT: The access key for the S3 bucket. If None (default value), then the value of environment variable AWS_ACCESS_KEY_ID is used.
  • --secret-key TEXT: The secret key for the S3 bucket. If None (default value), then the value of environment variable AWS_SECRET_ACCESS_KEY is used.
  • --tag TEXT: The tag name for the data source. If None (default value), then the tag latest will be assigned to the data source.
  • -q, --quiet: Output data id only. [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt ds tag

Tag an existing datasource in airt service.

Usage:

$ airt ds tag [OPTIONS]

Options:

  • -id, --data_id INTEGER: The data ID in the airt service. [required]
  • -n, --tag_name TEXT: The tag name for the datasource. [required]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.

airt ds train

Train a ML model for the given data source.

Usage:

$ airt ds train [OPTIONS]

Options:

  • -id, --data_id TEXT: The data ID in the airt service. [required]
  • --client_column TEXT: The name of the column that uniquely identifies the users/clients as string. [required]
  • --timestamp_column TEXT: Name of the timestamp_column specifying the time of an occurred event as a string.
  • --target_column TEXT: Name of the target event for which the model needs to be trained to make predictions. [required]
  • --target TEXT: Name of the target event for which the model needs to be trained to make predictions. [required]
  • --predict_after TEXT: Time delta in hours of the expected target event. [required]
  • -q, --quiet: Output model id only. [default: False]
  • -d, --debug: Set logger level to DEBUG and output everything. [default: False]
  • --help: Show this message and exit.
Back to top