Welcome to Starfishdata.ai Configuration
.env.template
file is provided to help users get started quickly. This file includes settings for API keys, model configurations, and other runtime parameters. Users are expected to copy the template to .env
and edit it with their specific configurations. cp .env.template .env
, nano .env
Sources: README.md
.env.template
file to .env
:
.env
file with your preferred editor to set the necessary API keys and configurations:
TELEMETRY_ENABLED=false
in their environment variables. Sources: README.md
/tmp/starfish_test_*
directories) to avoid interfering with production data. Sources: tests/data_factory/storage/README.md
LocalStorage
class in src/starfish/data_factory/storage/local/local_storage.py
handles the local storage implementation. The setup
method creates the necessary directories and database. Sources: tests/data_factory/storage/local/test_local_storage.py
{storage_uri}/configs/{master_job_id}.request.json
{storage_uri}/data/{record_uid[:2]}/{record_uid[2:4]}/{record_uid}.json
FileSystemDataHandler
class in src/starfish/data_factory/storage/local/data_handler.py
manages interactions with data and config files on the local filesystem. It ensures that all top-level data directories exist. Sources: src/starfish/data_factory/storage/local/data_handler.py
Directory | Description |
---|---|
CONFIGS_DIR | Directory where request configuration files are stored. |
DATA_DIR | Directory where record data files are stored. |
ASSOCIATIONS_DIR | Directory where associations files are stored (currently not in use). |
TEST_DB_DIR
and TEST_DB_URI
variables define the location of the test database. The TEST_MODE
variable determines whether to run a basic or full test. Sources: tests/data_factory/storage/test_storage_main.py