Welcome to Nextbit Handbook!

This handbook describes how we work, which tools we use, and how we suggest using them to be fully integrated into our team. Before you start working on a project, please skim through all sections and set up all the relevant tools.

Important

If something is not clear, ask around: colleagues are here to help. Even better, open an issue to improve the clarity of the murky sentence or section.

If you want to contribute to this handbook, check Contributing.

• Values
  • Self-discipline
  • Trust
  • Respect and Collaboration
  • Curiosity
  • Determination and Quiet Confidence
  • High-quality Work
• Your first day
  • Introduction
  • People
  • Accounts
    • Microsoft Account
    • Google Account
  • Devices
    • Computer
    • Smartphone
• Project workflow
  • Open a new repository
  • Connect local machine to remote repo
  • Start coding
  • Versioning your code
  • Open a Merge Request (MR)
  • Code review
  • After merging
• Machine Learning Development Guidelines
  • Before you start to build models
    • Do take the time to understand your data
    • Don’t look at all your data
    • Do make sure you have enough data
    • Do talk to domain experts
    • Do survey the literature
    • Do think about how your model will be deployed
  • How to reliably build models
    • Don’t allow test data to leak into the training process
    • Do try out a range of different models
    • Don’t use inappropriate models
    • Do optimize your model’s hyperparameters
    • Do be careful where you optimize hyperparameters and select features
  • How to robustly evaluate models
    • Do use an appropriate test set
    • Do use a validation set
    • Do evaluate models multiple times
    • Do save some data to evaluate your final model instance
    • Don’t use accuracy with imbalanced data sets
    • How to compare models fairly
    • Don’t assume a bigger number means a better model
    • Do use statistical tests when comparing models
    • Do correct for multiple comparisons
    • Don’t always believe results from community benchmarks
    • Do consider combinations of models
  • How to report your results
    • Do be transparent
    • Do report performance in multiple ways
    • Don’t generalize beyond the data
    • Do be careful when reporting statistical significance
    • Do look at your models
• Merge requests workflow
  • Introduction
    • Why are code reviews valuable?
    • Scope of a MR
  • Gitlab’s settings
    • Settings -> General -> Merge request settings
    • Settings -> Repository -> Push Rules
    • Settings -> Repository -> Protected Branches
  • Opening a new merge request
    • Title and description
    • Assignee and approvals
    • Other settings
  • Review
  • Improving
  • Merging
  • Other
    • Work in Progress status
• Git workflow
  • Scope of a branch
  • Owner of a branch
• Open source
  • Should I publish my project under an open source license?
  • Why open source?
  • Which license should I use?
  • Why GitHub and not GitLab?
  • Public projects
• Remote working manifesto
  • Internal communications
  • Video Calls
  • User Communication Guidelines
  • Say Thanks
  • In-person meetings
  • Tips for Working Remotely
  • “Coffee Break” Calls
  • How Remote Work is Changing the Workforce
• How to report a bug
  • Reporting a bug
  • Asking a new feature
  • Triaging an issue
• Working with big issues
• Permissions
  • Gitlab’s permissions
  • DNS permissions
  • GCP permissions
  • AWS permissions
  • Azure permissions
• VPN
  • Connect to VPN
• Gitlab CI
  • Our implementation
  • Improving
• Git Large File Storage
  • Introduction
  • Installation
  • Useful commands
• Testing
  • Why writing tests?
  • Testing levels
    • Unit tests
    • Integration tests
    • Black-box tests at the system level, aka end-to-end tests
  • Testing best practices
  • Software
    • Javascript
    • Python
    • Others
  • Gitlab CI
• Amazon Web Services (AWS)
  • First steps on AWS
    • Create a new AWS user
    • First log-in
    • Enable Virtual MFA
    • Generate Access Keys
    • Configure AWS CLI
  • Upload files on AWS Simple Storage Service (S3)
    • Storage classes
    • Other advanced settings
    • Pricing
  • Launch a Virtual Machine using AWS Elastic Compute Cloud (EC2)
    • Connect to your instance using SSH
    • Security groups
    • Pricing
  • Training a model on AWS
• Manage multiple AWS profiles on CLI
  • Credentials
  • Config
  • Usage