Skip to content

Commit

Permalink
docs: added the project proposal (#2)
Browse files Browse the repository at this point in the history
* Created the templete for the PID

* Completed Chapter 1 - Introduction

* Completed Chapter 2 - Related Work

* Completed till Research Methodology

* Completed the Methodology

* Completed the first draft

* Ignored latex helper files

* Finalize version of the Project Proposal

* Refactored the project folder
  • Loading branch information
isala404 authored Nov 13, 2021
1 parent f91305b commit 5e8527d
Show file tree
Hide file tree
Showing 7 changed files with 736 additions and 3 deletions.
7 changes: 4 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@


# Project Proposal
Project Proposal/*
!Project Proposal/*.tex
!Project Proposal/*.bib
proposal/*
!proposal/*.tex
!proposal/*.bib
!proposal/project-proposal.pdf


## Python
Expand Down
18 changes: 18 additions & 0 deletions proposal/acronym.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
\chapter*{List of Acronyms}

\begin{acronym}
\acro{iaas}[IaaS]{Infrastructure as a Service}
% \acro{saas}[SaaS]{Software as a service}
\acro{sres}[SRE]{Site Reliability Engineer}
\acro{sli}[SLI]{Service Level Indicator}
\acro{apm}[APM]{Application Performance Monitoring}
\acro{mttr}[MTTR]{Mean Time To Recovery}
\acro{gan}[GAN]{Generative adversarial networks}
\acro{hhmm}[HHMM]{Hierarchical hidden Markov model}
\acro{fsl}[FSL]{Few-shot Learning}
\acro{sdlc}[SDLC]{Software Development Life Cycle}
\acro{ooad}[OOAD]{Object-oriented analysis and design}
% \acro{vm}[VM]{Virtual Machine}
% \acro{cncf}[CNCF]{Cloud Native Computing Foundation}
\acro{ebpf}[eBPF]{Extended Berkeley Packet Filter}
\end{acronym}
42 changes: 42 additions & 0 deletions proposal/cover-page.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
% TITLE PAGE---------------------------------------------------
\begin{titlepage}

\begin{tikzpicture}[remember picture, overlay]
\draw[line width = 1pt] ($(current page.north west) + (1cm,-1cm)$) rectangle ($(current page.south east) + (-1cm,1cm)$);
\end{tikzpicture}

\begin{center}

% Upper part of the page
% \text{\large Informatics Institute of Technology}\\[0.1cm]
% \text{\large In Collaboration With}\\[0.5cm]
% \text{\large University of Westminster, UK}\\[2.5cm]

% Title
\includegraphics[width=5.0cm]{assets/IIT-Logo.png}\\[0.7cm]
{ \Huge Anomaly Detection \& Root Cause Analysis\\
In Distributed Systems }\\[0.7cm]
% \begin{minipage}{0.45\textwidth}
\text{\LARGE Project Proposal}\\[0.5cm]

% Authors
% \text{\large A dissertation by}\\[0.1cm]
\text{\large Isala Piyarisi}\\[0.1cm]
\text{\large w1742118 / 2018421}\\[3.2cm]

% Supervisor
\text{\large \textbf{Supervisor}: Guhanathan Poravi}\\[0.1cm]
\text{\large \textbf{Date}: $3^{rd} $ November 2021}\\[0.1cm]
\text{\large \textbf{Department}: Computer Science}\\[0.1cm]
\text{\large \textbf{Keywords}: Cloud Computing, AIOps, Monitoring, Disaster Recovery}\\[5cm]


\large{This project proposal is submitted in partial fulfilment of the requirements for the
BSc(Hons) Computer Science degree at the \\
University of Westminster.
} \\[0.5cm]


\end{center}

\end{titlepage}
74 changes: 74 additions & 0 deletions proposal/main.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
\documentclass[12pt]{report}

% Include all packages from file.
\input{preamble}

\renewcommand{\contentsname}{Table of Contents}
\renewcommand{\baselinestretch}{1.5}

% HEADER AND FOOTER--------------------------
\patchcmd{\chapter}{\thispagestyle{plain}}{\thispagestyle{fancy}}{}{}
\pagestyle{fancy}
\fancyhf{}
\lhead{\fontsize{10}{12}\leavevmode\selectfont\color{gray}{Anomaly Detection \& Root Cause Analysis In Distributed Systems | Project Proposal}}
\rfoot{\fontsize{10}{12}\leavevmode\selectfont\color{gray}{\thepage}}
\lfoot{\fontsize{10}{12}\leavevmode\selectfont\color{gray}{Isala Piyarisi | 2018421}}
\renewcommand{\headrulewidth}{0pt}
% END HEADER AND FOOTER--------------------------


% Document begins here
\begin{document}

\input{cover-page}

% Page Numbering---------------------------------------------
\pagenumbering{Roman}

% Table of Contents---------------------------------------------------
\tableofcontents
% List of Figures---------------------------------------------------
\addcontentsline{toc}{chapter}{\listfigurename}
\listoffigures
% List of Tables---------------------------------------------------
\addcontentsline{toc}{chapter}{\listtablename}
{\let\clearpage\relax
\listoftables
}
\cleardoublepage
\phantomsection
% Include acronyms
\addcontentsline{toc}{chapter}{List of Acronyms}
\input{acronym}

\input{sections/introduction}
\pagenumbering{arabic}
\input{sections/background}
\input{sections/problem}
\input{sections/research/motivation}
\input{sections/related-work}
\input{sections/research/gap}
\input{sections/research/contribution}
\input{sections/research/challenge}
\input{sections/research/question}
\input{sections/research/aim}
\input{sections/research/objective}
\input{sections/project-scope}
\input{sections/methodology/research}
\input{sections/methodology/development}
\input{sections/methodology/project-management}

\cleardoublepage
\phantomsection
\renewcommand{\bibname}{References}
\pagenumbering{Roman}
\setcounter{page}{5}
\addcontentsline{toc}{chapter}{References}
\bibliography{references.bib}

% \begin{appendices}
% \input{sections/appendix}
% \end{appendices}

\end{document}

88 changes: 88 additions & 0 deletions proposal/preamble.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
\usepackage[UKenglish]{babel}

\usepackage{setspace} % LINE SPACING
\usepackage{tikz}
\usepackage{titlepic}
\usepackage{graphicx}
\usepackage{newtxtext,newtxmath}
\usepackage[utf8]{inputenc}
\usepackage[a4paper,left=24.5mm, right=24.5mm, top=24.5mm, bottom=24.5mm]{geometry} %Paper margins
\usepackage{titlesec}
\usepackage{enumitem} % Custom enumerations
\usepackage[titles]{tocloft}

\usepackage{acronym}

\usepackage{hyperref} % Links

% Referencing
\usepackage{natbib} % Harvard referencing
% \usepackage[comma,colon]{natbib}
\citestyle{aysep={,}}
\bibliographystyle{agsm}

% Tables
\usepackage{longtable}
\usepackage{multirow}
\usepackage{xstring}
\usepackage{geometry}
\usepackage{array}


% Fonts size
\usepackage[font={small,it}]{caption}

% Date
\usepackage[useregional]{datetime2}

\usetikzlibrary{calc}
\newcommand\HRule{\rule{\textwidth}{1pt}}
\newcommand{\hsp}{\hspace{10pt}}
\titlespacing*{\chapter}{0pt}{20pt}{20pt} % CHAPTER SPACING
\titleformat{\chapter}[hang]{\Huge\bfseries}{Chapter \thechapter\hsp:\hsp }{0pt}{\Huge\bfseries}
\titleformat{\chapter}[display]{\fontsize{20pt}{0pt}\bfseries}{}{2pt}{}
\setlength{\parindent}{10ex}


% Setting TOC and Section number depth
\setcounter{tocdepth}{4}
\setcounter{secnumdepth}{4}
% line spacing in TOC
\setlength{\cftbeforechapskip}{3pt}

\onehalfspacing

\usepackage{chngcntr}

% \usepackage[nottoc,numbib]{tocbibind}
\counterwithout{figure}{chapter}
\counterwithout{table}{chapter}

\usepackage[font={small,it}]{caption}
\selectlanguage{UKenglish}

\usepackage{floatrow}

% Header and footer
\usepackage{fancyhdr}
\usepackage{etoolbox}

\usepackage[titletoc]{appendix}
\usepackage{changepage}


% TITLE FORMATS
% CHAPTER SPACING & FONT
\titleformat{\chapter}[hang]{\fontsize{16pt}{0pt}\bfseries}{\thechapter}{1em}{}
% \titlespacing*{\chapter}{0pt}{20pt}{10pt}

% SECTION FONT
\titleformat{\section}[hang]{\fontsize{14pt}{0}\bfseries}{\thesection}{1em}{}
% \titlespacing*{\section}{0pt}{20pt}{10pt}

% SUBSECTION FONT AND SIZE
\titleformat{\subsection}[hang]{\fontsize{12pt}{0}\bfseries}{\thesubsection}{1em}{}
% \titlespacing*{\subsection}{0pt}{15pt}{10pt}

\titleformat{\subsubsection}[hang]{\fontsize{12pt}{0}\itshape}{\thesubsubsection}{1em}{}
% \titlespacing*{\subsubsection}{0pt}{15pt}{10pt}
Binary file added proposal/project-proposal.pdf
Binary file not shown.
Loading

0 comments on commit 5e8527d

Please sign in to comment.