Code Monkey home page Code Monkey logo

mack's Introduction

MACK

The unofficial Enron email corpus search engine.

Installing / Running

Pre-requites

  1. Install Python 3.5 or above
  2. Download and save the sample and full enron email corpus as enron and enron_mail_20150507, respectively.
  3. Create a virtual environment and activate it before installing MACK.

Build and install the package.

python setup.py build && python setup.py install

Run MACK. Make sure to run MACK in the same directory where the email corpus is located.

mack --search app

What's next?

  • MOAR UNIT TESTS. The unit test coverage is very low, and I would want to get that at 100%.
  • The MACK search engine does not score the documents retrieved from a query. I found a ton of choices while I was researching about search engines, and it would be a cool weekend project to add scoring functionality. Some example choices: BM25, PageRank, tf-idf.
  • Reduce index build time. The build time takes about 12 seconds for the sample data set which is about 12mb. I briefly used Python's cProfiler and guppy to profile runtime and memory, but I felt it wasn't enough time to really find some optimizations. I could also take a step back and look at the architecture from a high-level and judge if it is really optimal.
  • Support multi-term querying. You can provide multiple terms to MACK, but it will only use the first term to query the inverted index. When I was started the challenge, I wanted to support phrase querying but quickly realized it was extremely ambitious to support that in two days.

Resources I used to help me complete the challenge.

F.A.Q.

  • Q: What does MACK stand for? A: Absolutely, nothing.

mack's People

Contributors

mpanelo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.