Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:

- uses: actions/setup-python@v4
with:
python-version: "3.9"
python-version: "3.11"
cache: "pip"

- name: Install Dependencies
Expand Down Expand Up @@ -54,7 +54,7 @@ jobs:

- uses: actions/setup-python@v4
with:
python-version: "3.9"
python-version: "3.11"
cache: "pip"

- name: Install Dependencies
Expand All @@ -66,7 +66,7 @@ jobs:
run: pre-commit run mypy --all-file

build-and-test:
name: "Build and Test Python 3.9"
name: "Build and Test Python 3.11"
runs-on: ubuntu-latest
if: always()
timeout-minutes: 20
Expand All @@ -76,7 +76,7 @@ jobs:
- name: Setup python
uses: actions/setup-python@v4
with:
python-version: "3.9"
python-version: "3.11"
cache: "pip"

- name: Install Dependencies
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/build_docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: 3.9.15
python-version: 3.11
cache: "pip"
- name: Installing the Documentation requirements
run: |
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/merge.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:

jobs:
build-and-test:
name: "Build and Test Python 3.9"
name: "Build and Test Python 3.11"
runs-on: ubuntu-latest
if: always()
timeout-minutes: 20
Expand All @@ -16,7 +16,7 @@ jobs:
- name: Setup python
uses: actions/setup-python@v4
with:
python-version: "3.9"
python-version: "3.11"
cache: "pip"

- name: Install Dependencies
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ repos:
rev: 22.6.0
hooks:
- id: black
language_version: python3.9
language_version: python3.11
- repo: https://github.com/pycqa/flake8
rev: 5.0.4
hooks:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
![docs](https://img.shields.io/github/actions/workflow/status/iai-group/UserSimCRS/build_docs.yaml?label=docs&branch=main)
![Tests](https://img.shields.io/github/actions/workflow/status/iai-group/UserSimCRS/merge.yaml?label=Tests&branch=main)
![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/NoB0/cd558f4b76df656b67277f8ae214b7e0/raw/coverage.UserSimCRS.main.json)
![Python version](https://img.shields.io/badge/python-3.9-blue)
![Python version](https://img.shields.io/badge/python-3.11-blue)

UserSimCRS is an extensible user simulation toolkit for evaluating conversational recommender systems.

Expand All @@ -27,7 +27,7 @@ We refer to the [documentation](https://iai-group.github.io/UserSimCRS/main) for

## Installation

The recommended version of Python is 3.9.
The recommended version of Python is 3.11.
The easiest way to install UserSimCRS and all of its dependencies is by using pip:

```shell
Expand Down
2 changes: 0 additions & 2 deletions config/default/config_default.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,4 @@ historical_ratings_ratio: 0.8

dialogues: data/datasets/moviebot/annotated_dialogues.json
intent_classifier: "cosine"
# If using the DIET classifier the following file needs to be provided.
# rasa_dialogues: data/agents/moviebot/annotated_dialogues_rasa_agent.yml

4 changes: 2 additions & 2 deletions config/llm_interface/config_ollama_default.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
host: "https://ollama.ux.uis.no"
host: "OLLAMA_URL"
model: "mistral-nemo:latest"
stream: False
options:
temperature: 0
temperature: 0.7
2 changes: 1 addition & 1 deletion config/llm_interface/config_ollama_information_need.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
host: "https://ollama.ux.uis.no"
host: "OLLAMA_URL"
model: "mistral-nemo:latest"
stream: False
format: "json"
Expand Down
2 changes: 1 addition & 1 deletion config/llm_interface/config_openai_default.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
model: "gpt-3.5-turbo"
api_key: "YOUR_API_KEY"
options:
temperature: 0
temperature: 0.7
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ slot_labels:
- YEAR
- OTHER

ollama_host: "https://ollama.ux.uis.no"
ollama_host: "OLLAMA_URL"
ollama_model: "mistral-nemo:latest"
ollama_options:
temperature: 0
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ slot_labels:
- YEAR
- OTHER

ollama_host: "https://ollama.ux.uis.no"
ollama_host: "OLLAMA_URL"
ollama_model: "mistral-nemo:latest"
ollama_options:
temperature: 0
16 changes: 4 additions & 12 deletions data/datasets/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,8 @@
# Dialogue files

The YAML files required to train the Rasa DIET classifier can be generated from the annotated dialogues saved in the correct format.
The generation of these files can be done with this command:
This folder contains dialogue files used for configuring a user simulator. For each dataset supported, annotated dialogues in JSON format are provided and associated prompts for LLM-based NLU and NLG components.

```shell
cd usersimcrs/utils
python -m annotation_converter_rasa -source PathToAnnotatedDialoguesFile -destination PathToDestinationFolder
```
The datasets currently supported are:

It creates the following files:

- `<originalname>_reformat.yaml`: The original file saved as a yaml file
- `<originalname>_types_w_examples.yaml`: Slots and example values extracted from the dialogues
- `<originalname>_rasa_agent.yaml`: Examples of agent utterances for all possible intents/actions that the agent can take
- `<originalname>_rasa_user.yaml`: Similar to the agent file, but for users
* MovieBot: dialogues related to movie recommendations obtained with IAI MovieBot v1.
* IARD: subset of ReDial dialogues related to movie recommendations.
3 changes: 2 additions & 1 deletion data/datasets/iard/agent_dialogue_acts_extraction_prompt.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
| Explain-Introduction (EXP-I) | Recommender explains recommendation with non-personalized introduction. | "What about Sleepless in Seattle (1993)? Hanks and Ryan?" |
| Explain-Preference (EXP-P) | Recommender explains recommendation based on the seeker's past preference. | "Will Ferrell is also very good in Elf (2003) if you're in need of another comedy" |
| Explain-Suggestion (EXP-S) | Recommender explains recommendation in a suggestive way. | "If you like gory then I would suggest The Last House on the Left (2009)." |
| Other (OTH) | Greetings, gratitude expression, or chit-chat utterances. | "Have a good night." |
| End (END) | Recommender ends the conversation. | "Awesome! Nice chatting with you...bye now" |
| Other (OTH) | Greetings, gratitude expression, or chit-chat utterances. | "Hi." |

| Slot |
| ---- |
Expand Down
Loading
Loading