Create README.md

README.md

@@ -0,0 +1,155 @@
+---
+
+tags:
+
+- code
+
+license: mit
+
+---
+
+# Model Card for Model ID
+
+This model recommends movies to users based on the movies they have voted for.
+
+# Model Details
+
+The model consists of three parts
+
+- Content-based filtering
+
+- Collaborative filtering
+
+- Ensemble model
+
+## Model Description
+
+Content-based filtering is used for recommending movies based on the content of their previously voted movies. e.g. genre, actors, ...
+
+By using collaborative filtering, similar interests are found and movies that have been voted for by some users are recommended to users who have not voted for them. It doesn't depend on the content and doesn't need domain knowledge.
+
+The ensemble model is created by combining the last two methods to give better recommendations. The algorithm finds similar people and then recommends films based on their votes, filtering them based on content preferences.
+
+- Developed by: Aida Aminian, Mohammadreza Mohammadzadeh Asl
+
+<!--- Shared by [optional]: [More Information Needed]-->
+
+- Model type: content-based filtering and collaborative and an ensemble model of these two model
+
+- Language(s) (NLP): not used, only TFIDF for keywords is used
+
+- License: MIT License
+
+## Model Sources
+
+MovieLens dataset
+
+# Uses
+
+Building recommendation systems
+
+## Direct Use
+
+Movie recommendations based on content and other similar people.
+
+<!-- ## Out-of-Scope Use -->
+
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+
+<!-- [More Information Needed] -->
+
+# Bias, Risks, and Limitations
+
+This ML model is based on an IMDB movie dataset. The dataset may have more focus on English movies.
+
+## Recommendations
+
+Add other metrics to model
+
+## How to Get Started with the Model
+
+Install the sklearn, pandas and numpy libraries for python. Download the MovieLens dataset and put that in the 'content/IMDB' path in the project directory. Use python interpreter to run the code.
+
+# Training Details
+
+## Training Data
+
+IMDB Movies
+
+### Preprocessing
+
+Extracting features from keywords. 
+
+<!-- ### Speeds, Sizes, Times -->
+
+<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+
+<!-- [More Information Needed] -->
+
+# Evaluation
+
+<!-- This section describes the evaluation protocols and provides the results. -->
+
+<!-- ## Testing Data, Factors & Metrics -->
+
+<!-- ### Testing Data -->
+
+<!-- This should link to a Data Card if possible. -->
+
+<!-- [More Information Needed] -->
+
+### Factors
+
+We've removed some of the wrong rows in the dataset.
+
+<!-- [More Information Needed] -->
+
+### Metrics
+
+percision@k and recall@k
+
+<!-- [More Information Needed] -->
+
+<!-- ## Results -->
+
+<!-- [More Information Needed] -->
+
+### Summary
+
+<!-- # Environmental Impact
+
+<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+
+<!-- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700). -->
+
+<!-- - Hardware Type: [More Information Needed] -->
+
+<!-- - Hours used: [More Information Needed] -->
+
+<!-- - Cloud Provider: [More Information Needed] -->
+
+<!-- - Compute Region: [More Information Needed] -->
+
+<!-- - Carbon Emitted: [More Information Needed] -->
+
+# Technical Specifications
+
+## Model Architecture and Objective
+
+Content-based filtering. 
+
+<!-- ## Compute Infrastructure -->
+
+<!-- [More Information Needed] -->
+
+### Hardware
+
+Works fine on google colab
+
+### Software
+
+python, sklearn, numpy, pandas
+
+<!-- # Model Card Contact -->
+
+<!-- [More Information Needed] -->