diff --git a/README.md b/README.md
index d8d7bb72b652b80951c8e7e9dbbd48743a0d3d8d..625d16f543609f379e5663f2a939d6af140bd91c 100644
--- a/README.md
+++ b/README.md
@@ -1,92 +1,67 @@
-# scoring
+# Scoring program
+## Specifications
+### Objective
+To compare the predictions from `predict.txt` against the correct answers in `solution.txt` and compute various metrics: accuracy, mean squared error(MSE).
-## Getting started
+### Format of files
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
-
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
-
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+* Both files should have the same number of lines.
+* Each line contains a sequence of three numbers separated by spaces, where each number is either '0' or '1'.
+Here is an example of the file:
```
-cd existing_repo
-git remote add origin https://gitlab.com/bvantuan/scoring.git
-git branch -M main
-git push -uf origin main
+1 0 0
+0 0 1
+1 0 0
+0 0 1
+0 0 1
+0 1 0
+1 0 0
+0 0 1
+1 0 0
+1 0 0
+0 0 1
+0 0 1
+0 0 1
+1 0 0
+0 0 1
```
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://gitlab.com/bvantuan/scoring/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
+### Metric:
+* **Accuracy**: It is the ratio of the number of correct predictions to the total number of predictions. For example, if out of 10 predictions, 8 are correct, the accuracy is 80% (or 0.8). A line in `predict.txt` is considered a "correct prediction" when its content matches exactly with the corresponding line in `solution.txt`.
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+To illustrate: Suppose a line in `solution.txt` is:
+```
+1 0 0
+```
+If the corresponding line in `predict.txt` is also 1 0 0, then it's a correct prediction. Conversely, if the corresponding line in `predict.txt` is 0 1 0 or 1 0 1 (or any sequence other than 1 0 0), then it's an incorrect prediction.
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+* Mean squared error(MSE): It quantifies the difference between the predicted values and the actual values. For each line, the squared difference between the numbers in `solution.txt` and `predict.txt` is computed and then averaged over all lines. The formula for MSE is:
+$$ MSE = \frac{1}{N} \sum_{i=1}^{N} (predicted_i - actual_i)² $$
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+Where $N$ is the total number of predictions.
+Suppose, for a particular line:
+* `solution.txt` has: 1 0 0
+* `predict.txt` has: 1 1 0
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+So, for this line, the squared error is $ (1 - 1)² + (1 - 0)² + (0 - 0)² = 1 $. Note that the MSE between two files would be the average of the squared errors for all lines.
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+## Role-playing
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+**Objective**: Enhance the existing codebase that currently only implements accuracy as a metric. As the project leader, you are to provide a release version of the code with extended functionalities. As the project leader, your first task is to create a comprehensive list of additional functionalities and improvements needed for the project:
+<ol type="a">
+ <li>Implement additional metric: Mean Squared Error (MSE)</li>
+ <li>Input validation: Ensure that the input files (`predict.txt` and `solution.txt`) are correctly formatted and handle possible errors gracefully.</li>
+ <li>Logging: Implement logging to capture the process and any potential errors. This will help in debugging and maintenance. </li>
+ <li>Testing: Introduce unit tests for each implemented metric and other functions. This ensures that any future changes do not break existing functionalities.</li>
+ <li>Documentation: Create comprehensive documentation that covers: how to use the program, a brief explanation of each metric, version history, etc.</li>
+ <li>Team allocation: Assign each task to a team member based on their expertise. Ensure each member is clear about their responsibilities and deadlines.</li>
+ <li>Testing and quality assurance: Once all functionalities are implemented, run an extensive testing phase. This includes both manual testing and automated unit tests.</li>
+ <li>Feedback loop: Allow a period for internal feedback. Let team members use the program and provide feedback, which might lead to some refinements.</li>
+ <li>Prepare release version: After all the above steps, consolidate the code, and prepare a release version. Ensure it is packaged with all dependencies and is easy to install/use.</li>
+ <li>Post-release maintenance: Even after the release, be prepared to fix any unforeseen bugs and possibly update the program based on user feedbacks or external contributions.</li>
+</ol>
-## License
-For open source projects, say how it is licensed.
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
diff --git a/predict.txt b/predict.txt
new file mode 100644
index 0000000000000000000000000000000000000000..d9aade81bb06da5a785250cc40eccc6821b3a67e
--- /dev/null
+++ b/predict.txt
@@ -0,0 +1,15 @@
+1 0 0
+0 1 0
+1 0 0
+0 0 1
+0 0 1
+0 1 0
+1 0 0
+0 0 1
+1 0 0
+0 1 0
+0 0 1
+0 0 1
+1 0 0
+1 0 0
+0 0 1
diff --git a/score.py b/score.py
new file mode 100755
index 0000000000000000000000000000000000000000..0f799d72fedfb6a644801074c1de40b2bf1149e8
--- /dev/null
+++ b/score.py
@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+import os
+from sys import argv
+import numpy as np
+
+
+if (os.name == "nt"):
+ filesep = '\\'
+else:
+ filesep = '/'
+
+
+def mkdir(d):
+ if not os.path.exists(d):
+ os.makedirs(d)
+
+
+# ========= Useful functions ==============
+def read_array(filename):
+ ''' Read array and convert to 2d np arrays '''
+ array = np.genfromtxt(filename, dtype=float)
+ if len(array.shape) == 1:
+ array = array.reshape(-1, 1)
+ return array
+
+
+def accuracy_metric(solution, prediction):
+ correct_samples = np.all(solution == prediction, axis=1)
+ return correct_samples.mean()
+
+
+def _HERE(*args):
+ h = os.path.dirname(os.path.realpath(__file__))
+ return os.path.join(h, *args)
+
+
+# =============================== MAIN ========================================
+if __name__ == "__main__":
+
+ #### INPUT/OUTPUT: Get input and output directory names
+
+ prediction_file = argv[1]
+ solution_file = argv[2]
+ score_file = open(_HERE('scores.txt'), 'w')
+
+ # # Extract the dataset name from the file name
+ prediction_name = os.path.basename(prediction_file)
+
+ # Read the solution and prediction values into numpy arrays
+ solution = read_array(solution_file)
+ prediction = read_array(prediction_file)
+
+ # Compute the score prescribed by the metric file
+ score = accuracy_metric(solution, prediction)
+ print("score: ", score)
+ print(
+ "======= (" + prediction_name + "): score(accuracy_metric)=%0.2f =======" % score)
+ # Write score corresponding to selected task and metric to the output file
+ score_file.write("accuracy_metric: %0.2f\n" % score)
+ score_file.close()
+
+
+
\ No newline at end of file
diff --git a/scores.txt b/scores.txt
new file mode 100644
index 0000000000000000000000000000000000000000..ea3d85c62bf2041e9bea61a66fac7c2481aa1341
--- /dev/null
+++ b/scores.txt
@@ -0,0 +1 @@
+accuracy_metric: 0.80
diff --git a/solution.txt b/solution.txt
new file mode 100644
index 0000000000000000000000000000000000000000..82d86612a7a206cbc333ed94b9f806e21b2ffb2f
--- /dev/null
+++ b/solution.txt
@@ -0,0 +1,15 @@
+1 0 0
+0 0 1
+1 0 0
+0 0 1
+0 0 1
+0 1 0
+1 0 0
+0 0 1
+1 0 0
+1 0 0
+0 0 1
+0 0 1
+0 0 1
+1 0 0
+0 0 1