diff --git a/src/00_intro/abstract.tex b/src/00_intro/abstract.tex
index 7b9f94fa5cdf69394e8041899a85ff4b2fdff259..25338b8ad090c23a7e25d41d96886b877e1af487 100644
--- a/src/00_intro/abstract.tex
+++ b/src/00_intro/abstract.tex
@@ -1,12 +1,12 @@
\chapter*{Abstract}
- This report presents the comprehensive development of \enquote{PanPal: A chef's chatbot}, aimed at enhancing the SmartEating platform by integrating an interactive cooking assistant.
+ This report presents the comprehensive development of \enquote{PanPal: A chef's chatbot}, aimed at enhancing the Smart Eating platform by integrating an interactive cooking assistant.
The project addresses the absence of a chatbot to assist users with various cooking-related tasks, leveraging both an OpenAI GPT model and Mixtral, an open source large language model (LLM) hosted at OST.
The report provides an in-depth analysis of the planning, execution, and evaluation phases of the project, highlighting the methodologies, risk management strategies, and the overall development lifecycle.
- The final product is a robust, user-friendly chatbot fully integrated into the SmartEating infrastructure.
+ The final product is a robust, user-friendly chatbot fully integrated into the Smart Eating infrastructure.
It offers a hands-free experience, allowing users to interact with the assistant without needing to touch their devices.
Despite some limitations, the project successfully meets its objectives and lays the groundwork for future enhancements.
- Key achievements include the development of a versatile cooking assistant, the successful integration of the chatbot into the SmartEating platform, and the implementation of effective project management strategies.
+ Key achievements include the development of a versatile cooking assistant, the successful integration of the chatbot into the Smart Eating platform, and the implementation of effective project management strategies.
The report includes a comparative analysis of the available assistants to aid users in making informed choices.
The report also highlights areas for future work, such as improving the Mixtral assistant's capabilities.
diff --git a/src/00_intro/achnowledgements.tex b/src/00_intro/achnowledgements.tex
index 4ef031561ccdc8907ed7a1a28c5cf96dd269bcf9..5dd80401701796d219cd6f723311fc3b0b1f1d55 100644
--- a/src/00_intro/achnowledgements.tex
+++ b/src/00_intro/achnowledgements.tex
@@ -6,6 +6,6 @@
I greatly appreciated having her as my advisor for the bachelor thesis.
I also want to thank Lars Herrmann, Abinas Kuganathan and Clemens Meier for their help throughout the project.
- Their contributions were greatly appreciated.
+ Their inputs were greatly appreciated.
Finally, I would like to thank my friends and family for their support, not only during this thesis, but over the past three years.
diff --git a/src/01_management-summary/management-summary.tex b/src/01_management-summary/management-summary.tex
index 33911a4cb65a24e73bca7b6a070c7c66264e4e4f..a8cd1aa2ee9844c0ce8ec06adc44a1acc9d3fc5f 100644
--- a/src/01_management-summary/management-summary.tex
+++ b/src/01_management-summary/management-summary.tex
@@ -1,15 +1,15 @@
\chapter{Management Summary}
\section{Problem}
- As described in the \nameref{sec:project-documentation/initial-project-description}, the SmartEating platform lacks an interactive chatbot.
+ As described in the \nameref{sec:project-documentation/initial-project-description}, the Smart Eating platform lacks an interactive chatbot.
This chatbot should be able to assist the user with various cooking related tasks.
- Additionally, the chatbot should integrate a GPT model from OpenAI as well as an large language model hosted at OST.
+ The chatbot should integrate a GPT model from OpenAI as well as an large language model hosted at OST.
Furthermore, the chatbot should provide a hands-free experience for the user.
\section{Techniques}
As a first step, \hyperref[sec:project-plan/processes-meetings]{Scrum} was selected as a short-term project management framework to iteratively create a working, presentable product.
To ensure that the project would be completed within the given timeframe, \hyperref[sec:project-documentation/long-term-plan/phases]{RUP} was chosen as a long-term project management framework.
- I have chose these project management frameworks because I already gathered some experience with them in previous projects.
+ I have these project management frameworks because I already gathered some experience with them in previous projects.
\section{Results}
The final solution successfully addresses the problem by delivering a robust, user-friendly chatbot.
@@ -45,14 +45,14 @@
}
\end{figure}
- The chatbot is fully integrated into the SmartEating infrastructure.
+ The chatbot is fully integrated into the Smart Eating infrastructure.
\begin{figure}[H]
\centering
\noindent\makebox[\textwidth]{
\includegraphics[width=1.3\linewidth]{screenshots/smart_eating.png}
}
- \caption{SmartEating platform with integrated chatbot}
+ \caption{Smart Eating platform with integrated chatbot}
\end{figure}
To help users make an informed decision about which assistant is best for them, the assistants are \hyperref[sec:appendix/assistant-comparison]{compared}.
@@ -62,9 +62,10 @@
The Mixtral assistant could be improved with further prompt engineering and providing a tool to search for the relevant recipe information.
The implementation of noise cancelling will allow users to use the chatbot even in noisy conditions.
+ If a user wants to swap ingredients, the chatbot should respect the user's preferences, allergies and eating habits.
These improvements, as well as eliminating the \hyperref[sec:product-documentation/limitations]{current limitations}, will provide a better user experience.
\section{Conclusion}
- The \enquote{PanPal: A chef's chatbot} project integrates a robust and user-friendly chatbot into the existing SmartEating platform.
+ The \enquote{PanPal: A chef's chatbot} project integrates a robust and user-friendly chatbot into the existing Smart Eating platform.
Despite some limitations, such as the Mixtral assistant's issues with ingredient quantities and step-by-step instructions, the project successfully meets its objectives and lays the groundwork for future enhancements.
diff --git a/src/02_product-documentation/architecture/data-flow.tex b/src/02_product-documentation/architecture/data-flow.tex
index febdd049ff1ef4f097e533e4a90ed22292579090..198157c4c69355cb1997b1951ce5363d00946566 100644
--- a/src/02_product-documentation/architecture/data-flow.tex
+++ b/src/02_product-documentation/architecture/data-flow.tex
@@ -1,5 +1,5 @@
\section{Data Flow}
- This section describes the data flow through the different \hyperref[sec:product-documentation/architecture/c4-diagrams/container-diagram]{containers} using the different input modes.
+ This section describes the data flow through the different \hyperref[sec:product-documentation/architecture/c4-diagrams/container-diagram]{containers} using the different input methods.
\subsection{Text Data Flow}
The following diagram illustrates the data flow when the user communicates with text.
@@ -10,7 +10,7 @@
\end{figure}
\subsection{Audio Data Flow}
- The following diagram illustrates the data flow when the user communicates with Audio, that is, when the user speaks the message instead of than typing it.
+ The following diagram illustrates the data flow when the user communicates with audio, that is, when the user speaks the message instead of typing it.
\begin{figure}[H]
\includegraphics[width=\linewidth]{diagrams/architecture/data_flow/voice_data_flow.png}
diff --git a/src/02_product-documentation/architecture/project-architecture.tex b/src/02_product-documentation/architecture/project-architecture.tex
index d4529096972b45bf1ef4b4b23a156fceb82a93c3..f2ac3cb1b707865e36004904bdb11140679aa598 100644
--- a/src/02_product-documentation/architecture/project-architecture.tex
+++ b/src/02_product-documentation/architecture/project-architecture.tex
@@ -1,14 +1,14 @@
\section{Project Architecture}
- This section provides an overview of the SmartEating project structure and the structure of the chatbot project that it contains.
+ This section provides an overview of the Smart Eating project structure and the structure of the chatbot project that it contains.
- \subsection{SmartEating Project Structure}
+ \subsection{Smart Eating Project Structure}
\begin{figure}[H]
\centering
\includegraphics[width=0.55\linewidth]{diagrams/out/projects.png}
- \caption{SmartEating project structure}
+ \caption{Smart Eating project structure}
\end{figure}
- The SmartEating project is a collection of multiple independent applications.
+ The Smart Eating project is a collection of multiple independent applications.
Each application has its own directory and can be built independently.
The diffrent applications are interconnected through the use of APIs.
diff --git a/src/02_product-documentation/architecture/toolstack.tex b/src/02_product-documentation/architecture/toolstack.tex
index 6f1ce59a94fbf1708b0a17f39bc36f2c13e1bec6..4ccc88e453bf35fdbf9a4adddf7b30eaf9fc36da 100644
--- a/src/02_product-documentation/architecture/toolstack.tex
+++ b/src/02_product-documentation/architecture/toolstack.tex
@@ -39,12 +39,12 @@
As the code must run as a web service, \href{https://pypi.org/project/uvicorn/}{uvicorn} is utilized.
\paragraph{openai-whisper}
- \href{https://pypi.org/project/openai-whisper/}{openai-whisper} is a speech-to-text model and is used as an alternative to whisper accessible via the OpenAI API.
+ \href{https://pypi.org/project/openai-whisper/}{Openai-whisper} is a speech-to-text model and is used as an alternative to whisper accessible via the OpenAI API.
This, because there may be people, which are not willing to share their voice with OpenAI.
With the locally hosted whisper, this can be guaranteed.
\paragraph{pydub}
- \href{https://pypi.org/project/pydub/}{pydub} is a package to handle and analyze audio data.
+ \href{https://pypi.org/project/pydub/}{Pydub} is a package to handle and analyze audio data.
It is used for the speech-to-text part of the application.
\paragraph{cachetools}
@@ -52,7 +52,7 @@
\subsection{Programming Languages}
\subsubsection{JavaScript}
- The web-application's frontend is written in JavaScript, specifically in React.
+ The web-application's frontend is written in JavaScript.
\subsubsection{C\#}
The web-application's backend is written in C\#.
@@ -64,10 +64,14 @@
\subsubsection{Docker}
Docker is used to containerize all services of the application.
+ \subsubsection{Gitlab CI}
+ The Smart Eating Docker images are built using Gitlab CI.
+ In addition, Gitlab CI is used to compile the documentation into a pdf.
+
\subsection{Documentation}
The documentation is written in \LaTeX, which makes collaboration and source control easy.
Additionally, it allows to generate a pdf, which is the preferred format for reports.
\subsubsection{Diagrams}
- Most of the diagrams are created as \enquote{diagrams as code} in python using the \href{https://pypi.org/project/diagrams/}{diagrams package} in markdown using \href{https://mermaid.js.org/}{mermaid}.
+ Most of the diagrams are created as \enquote{diagrams as code} in python using the \href{https://pypi.org/project/diagrams/}{diagrams package} and in markdown using \href{https://mermaid.js.org/}{mermaid}.
The long-term Gantt-Chart, however, is created using Microsoft Excel.
diff --git a/src/02_product-documentation/limitations.tex b/src/02_product-documentation/limitations.tex
index 4052ffdacbde26c69a89e3aeb92c4bf8e627b20e..af5ac98c50c01e6d6c02f254d9339d1f058c11ed 100644
--- a/src/02_product-documentation/limitations.tex
+++ b/src/02_product-documentation/limitations.tex
@@ -1,5 +1,5 @@
\chapter{Limitations}\label{sec:product-documentation/limitations}
- This chapter describes the limitations of the SmartEating chatbot.
+ This chapter describes the limitations of the Smart Eating chatbot.
\section{Audio limitations}
For optimal performance, users must speak loudly and clearly when interacting with the chatbot.
diff --git a/src/02_product-documentation/quality-measures/build-tools.tex b/src/02_product-documentation/quality-measures/build-tools.tex
index f5a9a4647ea3eb765f9487961823e240fb52606e..d2f1a7e85c7cb321ef106caacadcee467b744a90 100644
--- a/src/02_product-documentation/quality-measures/build-tools.tex
+++ b/src/02_product-documentation/quality-measures/build-tools.tex
@@ -1,10 +1,8 @@
\section{Build Tools}
- \subsection{SmartEating Project}
+ \subsection{Smart Eating Project}
Each push to the repository executes a CI pipeline, which in turn builds docker images for all project components.
These docker images are then published to the Gitlab internal registry.
- The unit tests are also automatically executed in this pipeline.
-
\subsection{Documentation}
Each push to the documentation repository triggers a build of the documentation.
As many diagrams are diagrams-as-code, these diagrams are built first and then consumed when building the documentation.
diff --git a/src/02_product-documentation/quality-measures/guidelines.tex b/src/02_product-documentation/quality-measures/guidelines.tex
index 457c8bb973126056943229edec08560f8dabfcde..0d74bdfc7cf94ba605fdbc7e535df7f0b180c810 100644
--- a/src/02_product-documentation/quality-measures/guidelines.tex
+++ b/src/02_product-documentation/quality-measures/guidelines.tex
@@ -11,7 +11,6 @@
\begin{itemize}
\item Each sentence must be on a new line.
- \item Each line must be 158 columns or less, excluded is text in itemize, enumerate, lstlistings, command definitions and environment definitions.
\item The content belonging to the title must be one intendation more than the title itself.
\item For intendation, spaces are used, not tabs.
\item One intendation is 4 spaces.
@@ -31,14 +30,14 @@
\paragraph{ESLint}
The de-facto standart Linter for JavaScript code is ESLint.
- It is already used in SmartEating project.
+ It is already used in Smart Eating project.
\subsubsection{C\#}
The C\# code must comply with the
\href{https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions}{common C\# code conventions}.
However, if there are deviations in the already used coding guidelines, they will be documented here.
- \paragraph{Resharper}
+ \paragraph{ReSharper}
ReSharper is a well-known productivity extension, integrated into JetBrains Rider.
It provides various features like quick fixes and code refactoring following defined coding conventions.
diff --git a/src/02_product-documentation/quality-measures/test-strategy.tex b/src/02_product-documentation/quality-measures/test-strategy.tex
index 6b4e67f3696102151a36ef9d05351501b02b6a10..0c6e0c70a67102ea7d9c076a77672c59d6b21bb9 100644
--- a/src/02_product-documentation/quality-measures/test-strategy.tex
+++ b/src/02_product-documentation/quality-measures/test-strategy.tex
@@ -15,7 +15,7 @@
\item \textbf{Fast}: Unit tests must be fast, meaning they must execute quickly so that they can be run frequently during development.
\item \textbf{Independent}: Unit tests must be independent of one another, meaning that the outcome of one test must not affect the outcome of another.
This ensures that each test is testing a specific and isolated unit of code.
- \item \textbf{Repeatable}: Unit tests must be repeatable, meaning that they must produce the same result every time they are run.
+ \item \textbf{Repeatable}: Unit tests must be repeatable, meaning that they must always produce the same result every time they are run with the same preconditions.
\item \textbf{Self-validating}: Unit tests must be self-validating, meaning that they must be able to automatically determine if they have passed or failed without human intervention.
This ensures that tests can be run as part of the continuous integration process.
\item \textbf{Timely}: Unit tests must be written in a timely manner, meaning that they must be written before or directly after the code they are testing is implemented, depending on the testing technique used.
@@ -70,4 +70,4 @@
\hyperref[sec:product-documentation/architecture/toolstack]{web-application's backend}.
\subsubsection{Python}
- In python, the de-facto standard framework for testing \href{https://github.com/pytest-dev/pytest}{pytest} is used.
+ In python, the de-facto standard framework for testing \href{https://github.com/pytest-dev/pytest}{pytest} is used if there is unit-testable code.
diff --git a/src/02_product-documentation/requirements/functional-requirements.tex b/src/02_product-documentation/requirements/functional-requirements.tex
index 1ea60c66b3e14078e3078ce6f16a7a687964c8a8..19904756a0347745974bd6e62e75acb2a48559a6 100644
--- a/src/02_product-documentation/requirements/functional-requirements.tex
+++ b/src/02_product-documentation/requirements/functional-requirements.tex
@@ -1,6 +1,6 @@
\section{Functional Requirements}
\subsection{Actor}\label{sec:fr/actor}
- There is only one actor, specifically a user visiting the SmartEating platform.
+ There is only one actor, specifically a user visiting the Smart Eating platform.
This actor wants to be guided through cooking process, as well as get related information.
Either, he wants to communicate with the system via text or voice.
@@ -12,7 +12,7 @@
\caption{Use case diagram}
\end{figure}
- Note: The user can hop from one use case to another in the last stage of the Chatbot.
+ Note: The user can hop from one use case to another in the last stage.
However, to increase readability and decrease complexity of the diagram, this is ommitted in the image.
\subsection{User Stories}
@@ -26,112 +26,112 @@
User Stories.
\userstory{Chatbot UI}{
- As a user I want the chatbot to be integrated into the SmartEating platform.
+ As a user, I want the chatbot to be integrated into the Smart Eating platform.
The chatbot should be easily accessible.
}
{1}
{\usprioritizationMustHave}
- \userstory{Assistant model}{
- As a user I want to be able to select the assistant model so I can interact with my preferred model.
+ \userstory{Assistant model selection}{
+ As a user, I want to be able to select the assistant model so I can interact with my preferred model.
}
{1}
{\usprioritizationMustHave}
\userstory{GPTAgent}{
- As a user I want to communicate with a GPTAgent.
+ As a user, I want to communicate with a GPTAgent.
}
{5}
{\usprioritizationMustHave}
\userstory{In-house LLM}{
- As a user I want to communicate with an OST in-house LLM.
+ As a user, I want to communicate with an OST in-house LLM.
Which one will be evaluated during the project.
}
{8}
{\usprioritizationMustHave}
\userstory{LLM comparison}{
- As a user I want to have a clean and simple comparison of the used LLMs.
+ As a user, I want to have a clean and simple comparison of the used LLMs.
}
{3}
{\usprioritizationMustHave}
\userstory{Communicate with text}{
- As a user I want to be able to communicate with the chatbot via text.
+ As a user, I want to be able to communicate with the chatbot via text.
}
{5}
{\usprioritizationMustHave}
\userstory{Select receipe}{
- As a user I want to be able to select the receipe to be cooked through the chatbot.
+ As a user, I want to be able to select the receipe to be cooked.
}
{5}
{\usprioritizationMustHave}
\userstory{Ingredients of receipe}{
- As a user I want to know, which ingredients are needed in the current receipe.
+ As a user, I want to know which ingredients are needed in the current receipe.
}
{5}
{\usprioritizationMustHave}
\userstory{Total time of receipe}{
- As a user I want to know what the total time expenditure is.
+ As a user, I want to know how much time is needed to complete the current recipe.
}
{3}
{\usprioritizationMustHave}
- \userstory{Next step}{
- As a user I want to be able to tell the chatbot to move on to the next step in the cooking process.
+ \userstory{Step-by-step guidance}{
+ As a user, I want to be able to tell the chatbot to provide step-by-step guidance, with the chatbot stopping at each step until I tell it to move on to the next step in the cooking process.
}
{5}
{\usprioritizationMustHave}
- \userstory{Communication type voice}{
- As a user I want to be able to communicate with the chatbot using my voice.
+ \userstory{Communication with audio}{
+ As a user, I want to be able to communicate with the chatbot using my voice.
}
{5}
{\usprioritizationShouldHave}
\userstory{Assistant takes user's eating habits into account}{
- As a user I want the assistant to take my eating habits, such as allergies, if I am vegetarian, vegan etc. into account.
+ As a user, I want the assistant to take my eating habits, such as allergies, if I am vegetarian, vegan etc. into account.
}
{5}
{\usprioritizationCouldHave}
\userstory{Further in-house LLMs}{
- As a user I want to be able to use all OST in-house LLMs.
+ As a user, I want to be able to use all OST in-house LLMs.
}
{21}
{\usprioritizationCouldHave}
\userstory{Remaining time}{
- As a user I want to know how much time is left until the receipe is completed.
+ As a user, I want to know how much time is left until the receipe is completed.
}
{8}
{\usprioritizationCouldHave}
\userstory{Steps of cooking process}{
- As a user I want to get on overview of the required steps to cook the meal.
+ As a user, I want to get on overview of the required steps to cook the meal.
}
{8}
{\usprioritizationCouldHave}
\userstory{Infos about previous steps}{
- As a user I want to be able to get information about previous steps.
+ As a user, I want to be able to get information about previous steps.
}
{3}
{\usprioritizationCouldHave}
\userstory{Saving the chat}{
- As a user I want my chat to be saved automatically, so I can pick up the conversation at any time again, even if I closed the application in
+ As a user, I want my chat to be saved automatically, so I can pick up the conversation at any time again, even if I closed the application in
the meantime.
}
{5}
- {\usprioritizationCouldHave}
+ {\usprioritizationWontHave}
\userstory{Recipe suggestion}{
- As a user I want to receive recipe suggestions based on my preferences.
+ As a user, I want to receive recipe suggestions based on my preferences.
}
{21}
{\usprioritizationWontHave}
diff --git a/src/02_product-documentation/requirements/non-functional-requirements.tex b/src/02_product-documentation/requirements/non-functional-requirements.tex
index 332451e4ef0afc8c27337e89a3ed8a0e0f394b11..223f5ecdaa5d51d64dc10cfb324aa8080c3b4d04 100644
--- a/src/02_product-documentation/requirements/non-functional-requirements.tex
+++ b/src/02_product-documentation/requirements/non-functional-requirements.tex
@@ -20,7 +20,7 @@
\nfr{Chatbot accessibility}{Accessibility}{High}{
The chatbot must be easily accessible.
}{
- The location of the chatbot is determined together with the stakeholders.
+ The location of the chatbot in the existing system is determined together with the stakeholders.
}
diff --git a/src/03_project-documentation/initial-project-description.tex b/src/03_project-documentation/initial-project-description.tex
index d33dc26a9c0351a7aeeb587751ab099851b19595..70f7371aa781e3feaec227c9710f1e86416851fb 100644
--- a/src/03_project-documentation/initial-project-description.tex
+++ b/src/03_project-documentation/initial-project-description.tex
@@ -6,7 +6,7 @@
Andri Joos
\section{Goal}
- This project builds on the smart eating platform under development at the Institute For Software.
+ This project builds on the Smart Eating platform under development at the Institute For Software.
Smart Eating is a web service for creating meal plans satisfying user's nutritional requirements, allergies, as well as likes and dislikes.
It also takes user's life-style constraints into account to come up with a meal plan.
@@ -68,4 +68,4 @@
The weighting of the assessment follows the guidelines for SA/BAs.
\section{Support}
- If necessary, support will be provided in the areas of smart eating onboarding and LLM servers.
+ If necessary, support will be provided in the areas of Smart Eating onboarding and LLM servers.
diff --git a/src/03_project-documentation/meeting-notes.tex b/src/03_project-documentation/meeting-notes.tex
index 77e93d0762f7562e3789b1946e2a6f726cdb4941..368fbd9914954a9116b2bff69ac0e6f1ebf25463 100644
--- a/src/03_project-documentation/meeting-notes.tex
+++ b/src/03_project-documentation/meeting-notes.tex
@@ -1,9 +1,9 @@
\chapter{Meeting Notes}
\section{09.02.2024 11:30}
\begin{itemize}
- \item Project is about implementing a chatbot on the SmartEating site
- \item SmartEating is an existing project
- \item Existing team can help with questions regarding the SmartEating application
+ \item Project is about implementing a chatbot in the Smart Eating platform
+ \item Smart Eating is an existing project
+ \item Existing team can help with questions regarding the Smart Eating application
\item Diffrent approaches
\begin{itemize}
\item GTPAgent
@@ -42,14 +42,14 @@
\begin{itemize}
\item Requirements are good so far
\item Long term plan looks good
- \item Unit tests are really recommended, if some user stories need to be dropped, we can do this in an agile was: if there is not enough time to fulfill all, we will drop some
+ \item Unit tests are really recommended, if some user stories need to be dropped, we can do this in an agile way: if there is not enough time to fulfill all, we will drop some
\item Meeting on the 18th march is cancelled due not much progress, as I am in Zivilschutz the week before
\end{itemize}
\section{Sprint 01 Review 06.02.2024 13:30}
\begin{itemize}
\item Progress is according to plan
- \item Long term plan maybe needs some adjustments after the next sprint due to Zivilschutz
+ \item Long term plan may needs some adjustments after the next sprint due to Zivilschutz
\end{itemize}
\subsection{Retrospective}
@@ -97,7 +97,8 @@
\begin{itemize}
\item Webapp backend already has a test project with MSTest
\item No tests available yet for Python/React
- \item React could be also tested
+ \item React could be also tested, but is not implemented yet.
+ Also, this is not needed.
\end{itemize}
\end{itemize}
@@ -216,7 +217,7 @@
\item Git Quality
\begin{itemize}
- \item In the Smarteating project, there are two leftover branches
+ \item In the Smart Eating project, there are two leftover branches
\begin{itemize}
\item For one, a MR is still to be merged, but no further work needed there (I can't merge branches into master because of permissions)
\item The second one is for the chatbot backend, which I didn't manage to finish.
@@ -236,7 +237,7 @@
\end{itemize}
\item Currently working in the webapp backend to connect to chat service
- \item Meeting this week with Abinas to discuss how to connect to llm's
+ \item Meeting this week with Abinas to discuss how to connect to LLMs
\end{itemize}
\section{In-house LLMs 10.04.2024 10:30}
@@ -279,10 +280,9 @@
\item The communication between webapp frontent, webapp backend, as well as the implementation of the OpenAI assistant and chat service is done in \href{https://git.joos.io/ost/ba/project/-/issues/8}{one ticket}.
\item This issue will be closed, as the main focus of this task, the implementation of the OpenAI assistant, is already done
\item A new task will be created to address the communication between the components.
- \item A new user story will be created to address the communication between the components.
\end{itemize}
- \item Long term plan needs an adjustment, to take the previously mentioned issue into account
+ \item Long term plan needs an adjustment to take the previously mentioned issue into account
\end{itemize}
\subsection{Retrospective}
@@ -303,7 +303,7 @@
\item Risk Reevaluation
\begin{itemize}
\item OpenAI model training takes too much time $\rightarrow$ L: 1, C: 1, the OpenAI assistant is good enough with finetuning the instructions, no specifically trained model needed
- \item Lack of experience in the in-house models API $\rightarrow$ C: 1, there is someone working in the SmartEating project, that can help me in case any clarification is needed
+ \item Lack of experience in the in-house models API $\rightarrow$ C: 1, there is someone working in the Smart Eating project, that can help me in case any clarification is needed
\end{itemize}
\item Code Quality
@@ -366,9 +366,9 @@
\item Reasoning why mixtral assistant is implemented with haystack and not langchain or implement in langchain
\item Next tasks:
\begin{itemize}
- \item voice chat
- \item current date \& date per recipe in recipe evaluation to prioritize today's recipes
- \item user information, if there is time to do that
+ \item Voice chat
+ \item Current date \& date per recipe in recipe evaluation to prioritize today's recipes
+ \item User information, if there is time to do that
\end{itemize}
\end{itemize}
@@ -466,6 +466,6 @@
\item Git Quality
\begin{itemize}
\item No leftover branches
- \item One MR is open, which will be reviewed by people in the SmartEating project
+ \item One MR is open, which will be reviewed by people in the Smart Eating project
\end{itemize}
\end{itemize}
diff --git a/src/03_project-documentation/personal-reports.tex b/src/03_project-documentation/personal-reports.tex
index 1f40b65b637104dc84357cdbca36be23dd9e3f17..d3bbd3f6efb23995ca050ef1439e294221848ff4 100644
--- a/src/03_project-documentation/personal-reports.tex
+++ b/src/03_project-documentation/personal-reports.tex
@@ -2,7 +2,7 @@
\section{What did go well}
The communication with the project advisor was always respectful, open and clear.
Both parties were able to contribute their knowledge and insights, creating an environment in which knowledge could be developed.
- In addition, the SmartEating team was always very helpful and supportive when I needed it.
+ In addition, the Smart Eating team was always very helpful and supportive when I needed it.
The defined processes were always followed, even if they could not always be verified.
diff --git a/src/03_project-documentation/project-plan/long-term-plan.tex b/src/03_project-documentation/project-plan/long-term-plan.tex
index 2ba6195a56a8bd3321fe16afed072f82a76b622b..76fe490421a47246805a58b8e62a90b1929f0025 100644
--- a/src/03_project-documentation/project-plan/long-term-plan.tex
+++ b/src/03_project-documentation/project-plan/long-term-plan.tex
@@ -9,8 +9,8 @@
\begin{itemize}
\item Inception (19.02.2024 - 04.03.2024)
\item Elaboration (04.03.2024 - 18.03.2024)
- \item Construction (18.03.2024 - 27.05.2024)
- \item Transition (27.05.2024 - 14.06.2024)
+ \item Construction (18.03.2024 - 03.06.2024)
+ \item Transition (03.06.2024 - 14.06.2024)
\end{itemize}
\subsection{Features}\label{sec:project-documentation/long-term-plan/features}
@@ -19,7 +19,7 @@
\begin{itemize}
\item Chatbot UI
\item Communication with chatbot via text
- \item Communication with chatbot via voice
+ \item Communication with chatbot via audio
\item Ask chatbot questions about receipe, chatbot answers
\item Select a receipe through chatbot
\item Chatbot guides through cooking process
diff --git a/src/03_project-documentation/project-plan/processes-meetings.tex b/src/03_project-documentation/project-plan/processes-meetings.tex
index 7577ffa2a83b922acbb1c11518e240f0ea7ae8b0..75f22ff1e8777ae7273ba87ec7978afba04acf9f 100644
--- a/src/03_project-documentation/project-plan/processes-meetings.tex
+++ b/src/03_project-documentation/project-plan/processes-meetings.tex
@@ -44,7 +44,7 @@
\begin{enumerate}
\item Documentation Quality
\begin{itemize}
- \item Check if documentation if properly formatted
+ \item Check if the documentation if properly formatted
\item Check for grammatical errors
\item Check if anything is missing or should be improved
\end{itemize}
diff --git a/src/03_project-documentation/project-plan/resources.tex b/src/03_project-documentation/project-plan/resources.tex
index 0c87dacb178679af778446bf99f7f0af9c9f343a..25ecb7c1641d53beb6728bf26ee24a8ce060f7d6 100644
--- a/src/03_project-documentation/project-plan/resources.tex
+++ b/src/03_project-documentation/project-plan/resources.tex
@@ -10,7 +10,7 @@
This project is part of my bachelor's thesis.
While I have a foundational understanding of Artificial Intelligence, my knowledge is limited to the courses AI Foundations and AI Applications,
- as well as my \href{https://studien.rj.ost.ch/allModules/40906_M_SAI21.html}{Studienarbeit} \cite{bib:sa} in the field of reinforcement learning.
+ as well as my \href{https://eprints.ost.ch/id/eprint/1177/}{Studienarbeit} in the field of reinforcement learning.
However, I am not very familiar with Large Language Models (LLMs).
I also have a good understanding of Git and source control in general.
@@ -20,8 +20,8 @@
\href{https://studien.rj.ost.ch/allModules/39012_M_SEProj.html}{Software Engineering Project}.
Throughout the course, I gained the necessary understanding of project management, project documentation, and project execution.
- I also have a lot of knowledge in the area of docker, as I have built a homeserver infrastructure on kubernetes and docker.
- For this and also for gitlab ci pipelines I had to create several docker images myself.
+ I also have a lot of knowledge in the area of Docker, as I have built a homeserver infrastructure on Kubernetes and Docker.
+ For this and also for Gitlab CI pipelines I had to create several docker images myself.
I am also proficient in Python and C\#, as I have used them in several private projects, school projects and business projects.
However, I have not yet used React.
@@ -37,7 +37,7 @@
\subsection{Costs}
As this is a bachelor thesis, I do not have a budget which can be expressed in money.
- However, the available budget be expressed as the earlier mentioned 360 hours, that I can use for this project.
+ However, the available budget can be expressed as the earlier mentioned 360 hours, that I can use for this project.
The costs for services, such as an OpenAI API subscription, will be covered by the university OST.
@@ -49,10 +49,10 @@
As UI for Git, \href{https://github.com/gitextensions/gitextensions}{gitextensions} is used.
To store the source code, the official \href{https://gitlab.ost.ch/}{OST Gitlab} instance is used as the project already lives there.
The Continuous Integration of this server is used to automatically build and test the application on pushes.
- To store the source code for the documentation a selfhosted instance of Gitlab reachable at \url{https://git.joos.io/ost/ba/report} is used.
+ To store the source code for the documentation a \href{https://git.joos.io/ost/ba/report}{repository} on a \href{https://git.joos.io/}{selfhosted instance of Gitlab} is used.
The issue tracking system of the before mentioned server will be used to keep track of the work and the time.
To collect and evaluate the time spent, \href{https://github.com/kriskbx/gitlab-time-tracker}{gtt} is used.
The documentation is written in \LaTeX.
- Microsoft Teams is used for the communication with the Advisor.
+ Microsoft Teams is used for the communication with the Advisor and the Smart Eating team.
diff --git a/src/03_project-documentation/project-plan/risk-management.tex b/src/03_project-documentation/project-plan/risk-management.tex
index e7c281d99a09c478d73d67f1b52d7dfd8d1cd468..f8cb74056e5e10b18669c7df3f7a3eb7b0abaf06 100644
--- a/src/03_project-documentation/project-plan/risk-management.tex
+++ b/src/03_project-documentation/project-plan/risk-management.tex
@@ -3,7 +3,7 @@
\subsection{Risk categorization method}
To rate the risks, they are categorized and assigned a value using the risk matrix below.
- The respective values can be found right next to the title of the risk, likelihood will be referred to as "L" and consequence as "C"
+ The respective values can be found right next to the title of the risk, likelihood will be referred to as "L" and consequence as "C".
\begin{figure}[H]
\centering
@@ -20,14 +20,14 @@
\risk{Lack of experience with OpenAI assistants}{2}{4}{
As I have never used OpenAI assistants, getting started with them could be time consuming.
}{
- I have already planned to familiarize myself with OpenAI assistants before implementing the agent in this project.
+ I have already planned to familiarize myself with OpenAI assistants by building a prototype.
}
\risk{Lack of experience with OpenAI API}{1}{4}{
I have never used the OpenAI API.
Therefore it could be time consuming to understand how to use it effectively.
}{
- I have already planned to familiarize myself with the API before implementing it into the project.
+ I have already planned to familiarize myself with the API by building a prototype.
}
\risk{OpenAI model training takes too much time}{1}{1}{
@@ -82,7 +82,7 @@
\riskchange{Lack of experience with OpenAI API}{8}{4}{OpenAI API is now known}{03.04.2024}
\riskchange{OpenAI model training takes too much time}{12}{1}{The OpenAI assistant is good enough with finetuning the instructions, no specifically
trained model needed}{24.04.2024}
- \riskchange{Lack of experience in the in-house models API}{12}{4}{There is someone working in the SmartEating project, that can help me in case any
+ \riskchange{Lack of experience in the in-house models API}{12}{4}{There is someone working in the Smart Eating project, that can help me in case any
clarification or help is needed}{24.04.2024}
\riskchange{Familiarization with existing project}{6}{3}{I'm pretty familiar with the project}{06.05.2024}
\riskchange{In-house models not working}{4}{2}{Mixtral model works very well}{06.05.2024}
diff --git a/src/04_Appendix/assistant-comparison.tex b/src/04_Appendix/assistant-comparison.tex
index b428cb14dd9029dc49794177a4afc249eae63b4f..d15f3e5da44e4358369e73a51bac3cdc2bae78aa 100644
--- a/src/04_Appendix/assistant-comparison.tex
+++ b/src/04_Appendix/assistant-comparison.tex
@@ -8,7 +8,7 @@
The \nameref{sec:appendix/testing-protocols/llm-behavior-tests} clearly show, that the Mixtral assistant currently has some significant deficites.
In particular, the hallucination of ingredient quantities and the inability to provide step-by-step guidance make the assistant very unreliable.
- The OpenAI assistant however provides assistance in the most common use cases.
+ The OpenAI assistant on the other hand provides assistance in all common use cases.
\section{Processing Speed}\label{sec:appendix/assistant-comparison/processing-speed}
The processing speed is tested for both text input and audio input.
@@ -42,13 +42,14 @@
\end{figure}
\subsection{Interim Conclusion}
- The OpenAI assistant is faster than the Mixtral assistant in all aspects.
+ Although these times are not entirely representative, they clearly show that the OpenAI assistant is much faster than the Mixtral assistant in all aspects.
\section{Privacy}\label{sec:appendix/assistant-comparison/privacy}
- The Mixtral assistant offers a high level of privacy because the Mixtral LLM used is hosted at OST and therefore the user's input is not sent to an external service.
+ The Mixtral assistant offers a high level of privacy because the used Mixtral LLM is hosted at OST and therefore the user's input is not sent to an external service.
The conversation is also only stored for one day, after which it is deleted and cannot be recovered.
The OpenAI assistant on the other hand uses the OpenAI API.
+ OpenAI stores the conversation history forever.
However, OpenAI claims, that they \href{https://platform.openai.com/docs/introduction}{do not use API data for training}.
\subsection{Interim Conclusion}
@@ -56,4 +57,4 @@
\section{Conclusion}
The previous comparisons clearly show, that the OpenAI assistant performs better than the Mixtral assistant in both \hyperref[sec:appendix/assistant-comparison/behavior-tests]{response quality and correctness} and \hyperref[sec:appendix/assistant-comparison/processing-speed]{speed}.
- What is better about the Mixtral assistant is its privacy.
+ What is better about the Mixtral assistant is its \hyperref[sec:appendix/assistant-comparison/privacy]{privacy}.
diff --git a/src/04_Appendix/testing-protocols.tex b/src/04_Appendix/testing-protocols.tex
index 7c16876dfea1137f085f614c58ceb3a29e47c5c8..8ebb48bb175118b3ce1c22559223fc1e566b29ba 100644
--- a/src/04_Appendix/testing-protocols.tex
+++ b/src/04_Appendix/testing-protocols.tex
@@ -3,7 +3,7 @@
For each test, the preconditions must be satisfied in order to ensure a clean and expected environment.
\newcommand{\testprotocolresultasexpected}{As expected}
- \newcommand{\testprotocolpreconditionchatbotinit}{Empty chatbot is open, input mode is text}
+ \newcommand{\testprotocolpreconditionchatbotinit}{Empty chatbot is open, input type is text}
\newcommand{\testprotocolpreconditionchatbotinitassistantdependent}[1]{\testprotocolpreconditionchatbotinit, #1 assistant is selected}
\input{04_Appendix/testing-protocols/ui-tests}
diff --git a/src/04_Appendix/tooling-evaluations/langchain-haystack.tex b/src/04_Appendix/tooling-evaluations/langchain-haystack.tex
index dd34c7294207fd9b54f76d4b860d14520973886b..9a01c6c59ffc4a31ab2be35e3a1840e9eec22497 100644
--- a/src/04_Appendix/tooling-evaluations/langchain-haystack.tex
+++ b/src/04_Appendix/tooling-evaluations/langchain-haystack.tex
@@ -21,7 +21,7 @@
It also has built-in support for a variety of NLP tasks.
- The key feature \href{https://docs.haystack.deepset.ai/docs/pipelines}{pipelines} is the counterpart to the LangChain chains.
+ The key feature \href{https://docs.haystack.deepset.ai/docs/pipelines}{Pipelines} is the counterpart to the LangChain chains.
Another key feature are the \href{https://docs.haystack.deepset.ai/v1.25/docs/agent}{Agents}.
Particularly interesting is the \href{https://docs.haystack.deepset.ai/v1.25/docs/agent#conversational-agent}{Conversational Agent}, which simplifies the usage of the LLM in a chatbot scenario, similar to the LangChain ConversationChain.
The Conversational Agent also handles the memory, so the LLM can answer context-based requests.
@@ -30,7 +30,7 @@
As it is less flexible than LangChain, Haystack is easier to get started with.
\subsection{Conclusion \& Decision}
- Of course, in this evaluation, only a small subset of the available concepts were discussed.
+ Of course, in this evaluation, only a small subset of the available concepts and tools were discussed.
However, most of the concepts can be found in both frameworks.
That's why I focused on evaluating the concepts, that are important to this project.
diff --git a/src/resources/diagrams/architecture/c4/container.py b/src/resources/diagrams/architecture/c4/container.py
index 2b4bf3944f80b533192a630d0ef0e08230fb4457..6264c3939da60c060c218285a840d12c1b4eafec 100644
--- a/src/resources/diagrams/architecture/c4/container.py
+++ b/src/resources/diagrams/architecture/c4/container.py
@@ -9,11 +9,11 @@ graph_attributes = {
def create_diagram():
with Diagram(name="", filename="out/container", show=False, direction="TB", graph_attr=graph_attributes):
- user = Person("User", description="A user of the SmartEating platform")
+ user = Person("User", description="A user of the Smart Eating platform")
openai_api = System("OpenAI API", external=True)
inhouse_llm_api = System("InHouse LLM API", external=True)
- with SystemBoundary("SmartEating Platform"):
+ with SystemBoundary("Smart Eating Platform"):
web_frontend = Container("Webapp Frontend", description="The Chatbot UI is located in here", technology="React")
web_backend = Container("Webapp Backend", technology="C#")
piccolodb = Container("PiccoloDB", technology="Python", description="Provides access to DB over an API")
diff --git a/src/resources/diagrams/architecture/c4/system_context.py b/src/resources/diagrams/architecture/c4/system_context.py
index 5b92bc6e1c7e72944fc41955e12159cae5b8eeff..9973fb98c4ff19972114e88871038b5bcbe33b1b 100644
--- a/src/resources/diagrams/architecture/c4/system_context.py
+++ b/src/resources/diagrams/architecture/c4/system_context.py
@@ -9,8 +9,8 @@ graph_attributes = {
def create_diagram():
with Diagram(name="", filename="out/system_context", show=False, direction="TB", graph_attr=graph_attributes):
- user = Person(name="User", description="A user of the SmartEating platform")
- smarteating = System(name="SmartEating Platform", technology="React, Python", external=False, width="2.3")
+ user = Person(name="User", description="A user of the Smart Eating platform")
+ smarteating = System(name="Smart Eating Platform", technology="React, Python", external=False, width="2.3")
openai_api = System(name="OpenAI API", external=True)
inhouse_llm_api = System("InHouse LLM API", external=True)
diff --git a/src/resources/diagrams/requirements/use_case.py b/src/resources/diagrams/requirements/use_case.py
index f863e1847f2dbf52416486edaf37a8a4405ed194..7e3eff6de7d610c8a32e8b99f7213dfd04f2fc7c 100644
--- a/src/resources/diagrams/requirements/use_case.py
+++ b/src/resources/diagrams/requirements/use_case.py
@@ -35,7 +35,7 @@ def create_diagram():
with Diagram(name="UseCase", filename="out/usecase", show=False, node_attr=node_attributes, edge_attr=edge_attributes, graph_attr=graph_attributes):
actor = Custom("User", "../resources/actor.png", labelloc="b", width="1.4", fontsize="15")
- with Cluster("SmartEating", "TB", graph_attr=cluster_attributes):
+ with Cluster("Smart Eating", "TB", graph_attr=cluster_attributes):
uc_open_chatbot = Node(label="Open chatbot")
with Cluster("Chatbot", "TB", graph_attr=cluster_attributes):