Change in README

[tre3x]

PR Type

Enhancement, Documentation

---

Description

• Removed the GUI implementation file (cutdetectorui.py).
• Updated the operation check in main.py from 'mepformat' to 'mepjson'.
• Updated the README:
  • Changed the link to the final submission blog.
  • Added a step to switch to the cutdetector-CLI branch during installation.
  • Removed outdated information about model paths and future work.

---

Changes walkthrough 📝

	Relevant files
Enhancement	cutdetectorui.py Removed the GUI implementation file.                                          cutdetectorui.py Removed the entire file. +0/-196  main.py Updated operation check for MEP JSON format.                          main.py Changed operation check from 'mepformat' to 'mepjson'. +1/-1
Documentation	README.md Updated documentation for installation and usage.                README.md Updated the link to the final submission blog. Added a step to switch to the cutdetector-CLI branch. Removed outdated information about model paths and future work. +4/-13

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[tre3x]

PR Description updated to latest commit (854449c)

[tre3x]

Ask❓

what are the changes in README?

Answer:

The changes in the README are as follows:

1. Link Update:

   • The link to the final submission blog has been updated from:

     [final submission blog](https://gsocblog-tre3x.netlify.app/final-project.html)

     to:

     [final submission blog](https://tre3x.github.io/final)

2. Branch Switch Instruction:

   • Added a step to switch to the cutdetector-CLI branch during installation:

     2. Switch to `cutdetector-CLI` branch `git checkout cutdetector-cli`

3. Dependency Installation Step:

   • The step number for installing dependencies has been updated accordingly:

     3. Install the neccessary dependencies by executing `conda env create -f environment.yml`

4. Singularity Command Update:

   • The Singularity command example has been simplified by removing the model path binding:

     singularity run FilmEditDetection.img --vidpath <path/to/video>

5. Removal of Outdated Information:

   • Removed outdated information about model paths:

     - `<path/to/model>` denotes the absolute path to trained model. If empty, the tool will tun on pre trained model.

   • Removed the "Future Work" section:

     ## Future Work
     - Additional features can be added to the tool which provides helpful insights into the film metrics.
     - There are few cases in which the tool fails to classify cuts, like in case of Jump cuts. In the future some other variant of the model
     can be used to classify the cuts which the current model fails to classify.
     - Some films have low contrast with high noise, in which it becomes difficult to classify cuts. Some preprocessing on training data to acheive the same
     and let the model learn those features.
     - The command line interface can currently handle one output operation at a time. It can be modified 
     to allow the user to generate outputs of multiple format at a time.