配置项

大约 6 分钟

配置项

这些没有默认值的配置项必须填写。强烈建议根据配置模板open in new window创建一个新的配置文件。点击每个配置项的“描述”查看该配置项的详细用法。

database

配置项类型默认值描述
data_store字符串用于数据存储的数据库,支持MySQL、PostgreSQL、ClickHouse和MongoDB。
cache_store字符串用于缓存存储的数据库,支持MySQL、PostgreSQL、MongoDB和Redis。
table_prefix字符串数据库中表(集合、键)的命名前缀。
cache_table_prefix字符串缓存存储数据库中表(集合、键)的命名前缀。如果为空,则使用table_prefix
data_table_prefix字符串数据存储数据库中表(集合、键)的命名前缀。如果为空,则使用table_prefix

data_storecache_store的DSN(Database Source Name)格式如下。

master

配置项类型默认值描述
host字符串"0.0.0.0"主节点 gRPC 服务监听IP(用于元数据交换)
port整型8086主节点 gRPC 监听端口(用于元数据交换)
http_host字符串"0.0.0.0"主节点 HTTP 服务监听IP(用于控制台和指标监控)
http_port整型8088主节点 HTTP 服务监听端口(用于控制台和指标监控)
n_jobs整型1主节点的工作线程数
meta_timeout整型10s元数据超时时间
dashboard_user_name字符串控制台登录用户名
dashboard_password字符串控制台登录密码

server

配置项类型默认值描述
default_n整型10默认返回条目数量
api_key字符串RESTful API 的密钥(需要 SSL)
clock_error整型5s集群中的时钟误差
auto_insert_user布尔值true插入新反馈时自动插入新用户
auto_insert_item布尔值true插入新反馈时自动插入新物品
cache_expire字符串10s服务节点本地缓存过期时间

recommend

配置项类型默认值描述
cache_size字符串100推荐缓存大小
cache_expire字符串72h推荐缓存过期时间

recommend.data_source

配置项类型默认值描述
positive_feedback_types字符串正向反馈的类型
read_feedback_types字符串已读反馈的类型
positive_feedback_ttl字符串0正反馈的有效时间
item_ttl字符串0物品的有效时间
配置项类型默认值描述
popular_window整型4320h以天为单位的热门物品的时间窗口

recommend.user_neighbors

配置项类型默认值描述
neighbor_type字符串"auto"相似用户算法
enable_index布尔值false使用聚类索引搜索相似用户
index_recall浮点0.8聚类索引的最小召回率
index_fit_epoch整型3聚类索引的最大拟合次数

recommend.item_neighbors

配置项类型默认值描述
neighbor_type字符串"auto"相似物品算法
enable_index布尔值false使用聚类索引搜索相似物品
index_recall浮点0.8聚类索引的最小召回率
index_fit_epoch整型3聚类索引的最大拟合次数

recommend.collaborative

配置项类型默认值描述
model_fit_period整型60m模型训练周期
model_search_period整型360m模型搜索周期
model_search_epoch整型100模型搜索中每个模型的训练迭代数
model_search_trials整型10模型搜索中试验模型数
enable_model_size_search布尔值false启用搜索不同大小的模型,这会占用更多内存
enable_index布尔值false使用 HNSW 索引加速协同过滤推荐
index_recall浮点0.9HNSW最小召回率
index_fit_epoch整型3HNSW最大拟合次数

recommend.replacement

配置项类型默认值描述
enable_replacement布尔值false将历史物品放回推荐池
positive_replacement_decay浮点0.8正向反馈物品放回衰减权重
read_replacement_decay浮点0.6已读反馈物品放回衰减权重

recommend.offline

配置项类型默认值描述
check_recommend_period整型1m触发离线推荐的周期
refresh_recommend_period整型24h强制刷新离线推荐的周期
enable_latest_recommend布尔值false离线推荐时启用最新推荐
enable_popular_recommend布尔值false离线推荐时开启热门推荐
enable_user_based_recommend布尔值false在离线推荐期间启用基于相似用户的推荐
enable_item_based_recommend布尔值false在离线推荐期间启用基于相似物品的推荐
enable_collaborative_recommend布尔值true离线推荐时启用协同过滤推荐
enable_click_through_prediction布尔值false在离线推荐期间启用点击率预测。否则,多路推荐的结果将被随机合并
explore_recommend字段{ popular = 0.0, latest = 0.0 }在探索推荐阶段,将热门物品或最新物品注入推荐结果的比例

recommend.online

配置项类型默认值描述
fallback_recommend字符串["latest"]离线推荐耗尽时的兜底的推荐算法
num_feedback_fallback_item_based整型10在线相似物品推荐使用的用户正反馈数量

环境变量

部分配置可以被环境变量覆盖。

配置项环境变量
database.cache_storeGORSE_CACHE_STORE
database.data_storeGORSE_DATA_STORE
database.table_prefixGORSE_TABLE_PREFIX
database.cache_table_prefixGORSE_CACHE_TABLE_PREFIX
database.data_table_prefixGORSE_DATA_TABLE_PREFIX
master.portGORSE_MASTER_PORT
master.hostGORSE_MASTER_HOST
master.http_portGORSE_MASTER_HTTP_PORT
master.http_hostGORSE_MASTER_HTTP_HOST
master.n_jobsGORSE_MASTER_JOBS
master.dashboard_user_nameGORSE_DASHBOARD_USER_NAME
master.dashboard_passwordGORSE_DASHBOARD_PASSWORD
server.api_keyGORSE_SERVER_API_KEY
Loading...