Giter Club home page Giter Club logo

project_structure's Introduction

project_structure

This is a description of contents that idealy a repository or a package should have. Taken mainly from observation of projects designed by Joel Grus.

The following are sections that a README.md file should contain:

Content (Desirable)

Section Description
Project structure main elements of a project structure
Installation How to install the package
Overview Overview of the package
Usage Quickstart examples
Doc Detailed documentation
Examples Detailed examples on how to fine-tune Bert
Notebooks Introduction on the provided Jupyter Notebooks

Project Structure

PROJECT FOLDER CONTAINS:

\t-Examples

-Notebooks

-Project name (code)

-Samples?

-Tests

README.md

LICENSE

Requirements.txt

setup.py (this is to be able to pip install!)

Instalation

Overview

project_structure's People

Contributors

irenedet 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.