Code Monkey home page Code Monkey logo

sumrized's Introduction

Sumrized

Arabic Text Summarization

Starting Project

  • Make sure you have installed pip (Python 3)

    sudo apt-get install python3-pip
    
  • Make sure you have NLTK (Natural Language Tool Kit) installed (Python 3)

    sudo pip install -U nltk
    

Project content

.  
├── docs                    <- All documentation about project
│   ├── reports             <- Reports for current project advancement 
│   ├── references          <- All references papers, links related to this project goes here   
│   └── sphinx              <- Automaticaly genereated API documentation form stringdocs in code
│
├── lib                     <- All project's source code goes here
│   ├── data-generation     <- Code for data generation if needed 
│   └── preprocessing       <- Code for data preprocessing 
│ 
├── models                  <- Contains code to train, test and run models 
│   ├── dumps               <- trained models file
│   └── scripts             <- script to run models 
│ 
├── Readme.md               <- Contains current project info
├── requirements.txt        <- Packages and modules needed for the current project to run
└── tests                   <- Unit test for the code in lib/ 
    └── lib  
        ├── analysis  
        ├── data-generation   
        └── preprocessing
   

Guide lines

Data

  • Symlink to your Raw data

        user@host:/my/awesome/project$ ln -s /path/to/your/raw/data . 
    
  • Data location must follow this structure:

data  
├── raw             <- Raw data
├── temp            <- transformed data stored temporarily if needed 
└── preprocessed    <- preprocessed data to run in a model

Data is immutable

  • Treat the data/raw (and its format) as immutable. Don't ever edit your raw data, especially not manually, and especially not in Excel.
  • Don't overwrite your raw data. Don't save multiple versions of the raw data.
  • The code you write should move the raw data through a pipeline to your final analysis.
  • You shouldn't have to run all of the steps every time you want to make a new figure, but anyone should be able to reproduce the final products with only the code in lib/ and the data in data/raw.

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.