Skip to content
Snippets Groups Projects
Commit a2f6c779 authored by finn's avatar finn
Browse files

Update documentation and remove unused prompt file

parent 640615a9
No related branches found
No related tags found
No related merge requests found
# Documentation # Documentation
## Overview This folder contains some additional documentation for the SyNDRA project as well as the final report and presentation.
This documentation folder serves as the central hub for all our project's documentation. It is systematically organized into two main subfolders: one for various notes including meeting notes and proposals, and another for the project plan detailing steps, deadlines, and an overall explanation of the project.
## Contents ## Contents
**notes/** - This folder houses a collection of important notes related to our project. It includes:
Meeting notes: Records of discussions and decisions made during team meetings.
Proposals: Documents outlining proposed ideas, methodologies, or changes.
Other notes: Any additional notes pertinent to the project.
**project_plan/** - Contains detailed documentation of the project plan. This includes: - [Project Report](report.pdf) - The final report for the project.
Steps: A step-by-step outline of the project's workflow. - [Presentation](final_presentation.pdf) - The final presentation for the project.
Deadlines: Key dates and milestones for the project. - [MultiWOZ Problems](multiwoz_problems.md) - An Explanation of the problems with the MultiWOZ dataset and why a new database was created.
Project explanation: An overarching description of the project, its goals, and its significance. - [OSM Data Analxsis](osm_data_analysis.md) - An analysis of the OpenStreetMap data used to create the HeidelKBerg database.
- [Project Plan](project_plan/project_plan.md) - The initial project plan for the project.
## Notes \ No newline at end of file
The notes folder is an essential resource for team members to stay informed and aligned. It contains detailed records of meetings, proposals, and other significant notes that provide insights and direction for the project.
### Usage
Regularly review these documents to stay updated on the latest decisions and ideas. They are crucial for maintaining continuity and consistency throughout the project's lifecycle.
## Project Plan
The project_plan folder is the blueprint of our project. It lays out the planned steps, highlights important deadlines, and provides a comprehensive explanation of the project.
### Usage
This folder is a guide for the project’s timeline and objectives. It should be consulted frequently to ensure that the project is on track and aligns with the set goals and deadlines.
1. High Level Instruction:
Simulate to be a system and respond to a user. Only generate system and user dialogue, without any action descriptions.
2. Description of the Dialogue Setup:
The user requests a specific act of service as expected by an online service system. The system asks the user for necessary details, verifies the applicability of the user’s requests to the Domain Knowledge and then after potential adjustments, provides the service. Every user message should be followed by a system message. Always remain courteous and ensure to bid farewell. All statements made by the system should adhere to the Domain Knowledge provided.
3. Domain knowledge
[TRIPLETS]
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment