CLI

Cyyrus comes with a powerful CLI that lets you interact with the system from the comfort of your terminal. The CLI is your go-to tool for generating data, managing schemas, and publishing datasets. It’s like a sidekick, always there to lend a hand.

`cyyrus run`

Generate the dataset as per the schema and optionally export the data or upload it to Hugging Face.

Options

--log-level

string

default: "INFO"

Set the logging level. Choices: DEBUG, INFO, WARNING, ERROR, CRITICAL.

--human-readable

boolean

default: "True"

Use human-readable log format.

--log-file

string

default: "cyyrus.log"

Name of the log file.

--log-dir

string

Directory to store log files.

--schema-path

string

required

Path to the schema file.

--env-path

string

Path to the optional environment file.

--export-format

string

Format to export the dataset.

--export-path

string

Directory to export the dataset.

--huggingface-token

string

Hugging Face token for authentication.

--repo-id

string

Hugging Face repo ID for dataset upload.

Usage

cyyrus run --schema-path /path/to/schema.yaml [OPTIONS]

Examples

Basic usage with default options:
```
cyyrus run --schema-path ./schema.yaml
```

Changing log level and log file:

cyyrus run --schema-path ./schema.yaml --log-level DEBUG --log-file debug.log

Exporting data to a specific format and location:

cyyrus run --schema-path ./schema.yaml --export-format json --export-path ./output

Using an environment file and uploading to Hugging Face:

cyyrus run --schema-path ./schema.yaml --env-path .env --huggingface-token YOUR_TOKEN --repo-id your-username/your-dataset

FAQ

Cyyrus provides flexible logging options. You can set the log level using the --log-level option, choose between human-readable and machine-readable formats with --human-readable, specify a log file name with --log-file, and set a custom directory for log files using --log-dir.

For example:

cyyrus run --schema-path ./schema.yaml --log-level DEBUG --log-file cyyrus_debug.log --log-dir ./logs

This command will run Cyyrus with DEBUG level logging, output to a file named cyyrus_debug.log in the ./logs directory.

Cyyrus allows you to export your processed data using the --export-format and --export-path options. The --export-format option determines the format of your exported data, while --export-path specifies where the exported data should be saved.

For instance:

cyyrus run --schema-path ./schema.yaml --export-format csv --export-path ./exported_data

This will process your data according to the schema and export it in CSV format to the ./exported_data directory.

Yes, Cyyrus supports direct uploads to Hugging Face. To do this, you need to provide your Hugging Face token and the repository ID where you want to upload the dataset.

Use the --huggingface-token option to provide your authentication token, and --repo-id to specify the target repository.

For example:

cyyrus run --schema-path ./schema.yaml --huggingface-token hf_xxx --repo-id username/dataset-name

This command will process your data and then upload it to the specified Hugging Face repository.

`cyyrus init`

Creates a new schema file with the specified name.

In development now. We’d love to hear if this is important to you.

`cyyrus validate`

Validate an existing schema file for correctness.

In development now. We’d love to hear if this is important to you.

Overview

Quickstart

Concepts

Schema

Tasks

`cyyrus run`

Options

Usage

Examples

FAQ

`cyyrus init`

`cyyrus validate`

Overview

Quickstart

Concepts

Schema

Tasks

​cyyrus run

​Options

​Usage

​Examples

​FAQ

​cyyrus init

​cyyrus validate

`cyyrus run`

Options

Usage

Examples

FAQ

`cyyrus init`

`cyyrus validate`