dreamtools is a package exposes high-level API for creating and editing Dream configuration files as well as a CLI interface.
Install from GitHub
pip install git+https://github.com/deeppavlov/deeppavlov_dreamtools.git --force-reinstall
or install in editable mode from cloned repo locally (useful for development purposes)
pip install -e .
There are 4 main objects which represent Dream configurations:
from deeppavlov_dreamtools import AssistantDist, Pipeline, DreamComponent, DreamService
dist = AssistantDist.from_name("ai_faq_assistant", dream_root="/home/username/projects/dream")
new_dist = dist.clone(
name="cloned_dist",
display_name="Cloned AI FAQ Assistant",
author="me@email.org",
description="Yet another cloned assistant",
)
# common methods
# add component to distribution
component = DreamComponent.from_file("components/pGxj32ic41pvquRXUdqc7A.yml", dream_root="/home/username/projects/dream")
new_dist.add_component()
# save and generate new configs which include the annotator "spelling_preprocessing" added earlier
new_dist.save(overwrite=True, generate_configs=True)
# or generate configs separately
new_dist.generate_pipeline_conf()
new_dist.generate_compose()
# remove previously added component
new_dist.remove_component("annotators", "spelling_preprocessing")
new_dist.save(overwrite=True, generate_configs=True)Represents distribution object.
You can either load it from classmethods from_name, from_dist
or initialize it directly passing underlying objects see initializing from scratch
In dream repository, distributions are found inside assistant_dists
from deeppavlov_dreamtools import AssistantDist
dist = AssistantDist.from_name("ai_faq_assistant", dream_root="/home/username/projects/dream")Represents pipeline object.
You can either load it from classmethod from_name
or initialize it directly passing underlying objects see initializing from scratch
In dream repository, Pipelines are found inside assistant_dists/{dist_name}
from deeppavlov_dreamtools import Pipeline
pipeline = Pipeline.from_name("ai_faq_assistant", dream_root="/home/username/projects/dream")Represents component object. Component is a part of Pipeline which describes how to interact with a service. It is represented by a YML file that looks like this:
Example Component File
name: entity_detection
display_name: Entity Detection
component_type: null
model_type: NN-based
is_customizable: false
author: publisher@deeppavlov.ai
description: extracts entities and their types from utterances
ram_usage: 5.5G
gpu_usage: null
group: annotators
connector:
protocol: http
timeout: 1.0
url: http://entity-detection-ru:8103/respond
dialog_formatter: state_formatters.dp_formatters:entity_detection_formatter_dialog
response_formatter: state_formatters.dp_formatters:simple_formatter_service
previous_services:
- annotators.spelling_preprocessing
- annotators.sentseg
required_previous_services: null
state_manager_method: add_annotation
tags: null
endpoint: respond
service: annotators/entity_detection_rus/service_configs/entity-detection-ru
date_created: '2023-03-16T09:45:32'
You can load it from classmethod from_file
In dream repository, Components are found inside components
from deeppavlov_dreamtools import DreamComponent
component = DreamComponent.from_file("components/1Q9QXih1U2zhCpVm9zxdsA.yml", dream_root="/home/username/projects/dream")Represents service object. Service is a part of Component which describes how to deploy a service.
Multiple components can use a single service.
You can load it from classmethods from_config_dir, from_source_dir
In dream repository, Services are found inside {service_group}/{service_name}/service_configs/{config_name}
from deeppavlov_dreamtools import DreamService
component = DreamService.from_config_dir(path="annotators/SentSeg/service_configs/sentseg", dream_root="/home/username/projects/dream")from deeppavlov_dreamtools import AssistantDist, Pipeline, DreamComponent, DreamService
from deeppavlov_dreamtools.distconfigs.generics import PipelineConfMetadata
dist = AssistantDist(
dist_path="/home/username/projects/dream/assistant_dists/ai_faq_assistant",
name="ai_faq_assistant",
dream_root="/home/username/projects/dream",
pipeline=Pipeline(
config=None,
metadata=PipelineConfMetadata(
display_name="AI FAQ Assistant",
author="me@email.org",
description="Answers FAQ Questions",
),
annotators={
"sentseg": DreamComponent.from_file("components/gM4fEjvVqLlSRRRkQfds2g.yml", "/home/username/projects/dream"),
"prompt_goals_collector": DreamComponent.from_file("components/fOud1KbT6qhY.yml", "/home/username/projects/dream"),
"prompt_selector": DreamComponent.from_file("components/fOud1KbT6qhY.yml", "/home/username/projects/dream"),
},
skills={
"dff_ai_faq_prompted_skill": DreamComponent.from_file("components/sQjaqWKJjVWjVEIbNuA.yml", "/home/username/projects/dream"),
"dummy_skill": DreamComponent.from_file("components/uYkoK0vRp4bbIg9akI1yw.yml", "/home/username/projects/dream"),
},
response_selectors={
"response_selector": DreamComponent.from_file("components/YJzc7NwGrLmKp6gfZJh7X1.yml", "/home/username/projects/dream")
},
last_chance_service=DreamComponent.from_file("components/70NLr5qqOow5.yml", "/home/username/projects/dream"),
timeout_service=DreamComponent.from_file("components/x8rLTpIWct4P.yml", "/home/username/projects/dream"),
response_annotators={
"sentseg": DreamComponent.from_file("components/1Q9QXih1U2zhCpVm9zxdsA.yml", "/home/username/projects/dream"),
},
response_annotator_selectors=DreamComponent.from_file("components/LXrJDIf43gwNmPMNXG5Eg.yml", "/home/username/projects/dream"),
candidate_annotators={
"combined_classification": DreamComponent.from_file("components/PbLNvh4hrvs47rPaf2bfYQ.yml", "/home/username/projects/dream"),
"sentence_ranker": DreamComponent.from_file("components/XGwmAHtAOu0NDqqG3QCJw.yml", "/home/username/projects/dream"),
},
skill_selectors={
"description_based_skill_selector": DreamComponent.from_file("components/dfsw4bji8bgjq2.yml", "/home/username/projects/dream"),
},
services={https://github.com/deeppavlov/deeppavlov_dreamtools/blob/fix/cli-actions/README.md
"transformers_lm_oasst12b": DreamComponent.from_file("component/sdkajfhsidhf8wfjh2ornfkle.yml", "/home/username/projects/dream")
},
),
)
# save and generate configs
dist.save(overwrite=True, generate_configs=True)dreamtools support a number of commands to ease Dream development.
You can always refer to
dreamtools {command} --help
or
dreamtools {command} {subcommand} --help
to see available arguments.
All CLI commands start with the main command dreamtools.
You can either call it from inside the cloned Dream directory or provide it as an argument:
dreamtools -D home/username/projects/dream {command} {subcommand} ...
Create new Dream distribution
dreamtools new dist my_assistant \
--display-name "My Assistant" \
--author myemail@email.org \
--description "My custom Distribution" \
--annotators components/1Q9QXih1U2zhCpVm9zxdsA.yml \
--annotators components/dflkgjdlkh342r9ndf.yml \
--annotators components/tgzaSQggV7wgMprOmF1Ww.yml \
--annotators components/M1sE6hOm20EGBWBdr0vIOw.yml \
--annotators components/O4FVnkAwjay1mL1FbuRGWw.yml \
--skills components/4yA8wZWOEnafRfz6Po9nvA.yml \
--skills components/qx0j5QHAzog0b39nRnuA.yml \
--skills components/ckUclxqUplyzwmnYyixEw.yml \
--skills components/uYkoK0vRp4bbIg9akI1yw.yml \
--response-annotators components/dflkgjdlkh342r9ndf.yml \
--response-annotators components/05PqJXVd7gV7DqslN5z3A.yml \
--last-chance-service components/70NLr5qqOow5.yml \
--timeout-service components/x8rLTpIWct4P.yml \
--response-annotator-selectors components/LXrJDIf43gwNmPMNXG5Eg.yml \
--skill-selectors components/xSwFvtAUdvtQosvzpb7oMg.yml \
--response-selectors components/KX4drAocVa5APcivWHeBNQ.yml \
--overwrite
Clone existing (--template argument) distribution
dreamtools clone dist dream_adventurer_openai_prompted \
--template dream_persona_openai_prompted \
--display-name "Dream Adventurer" \
--author deepypavlova@email.org \
--description "This is a simple dialog system that can chat with you on any topic. It has a pre-defined personality and uses OpenAI ChatGPT model to generate responses." \
--overwrite
Add component from component card to distribution
dreamtools add component components/jkdhfgkhgodfiugpojwrnkjnlg.yml --dist dream_persona_openai_prompted