Eric Ma
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights
    • Engagement control
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Versions and GitHub Sync Note Insights Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Engagement control Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       owned this note    owned this note      
    Published Linked with GitHub
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    --- title: How software skills enable data scientists to collaborate faster tags: Templates, Talk description: View the slide with "Slide Mode". --- # Software Skills & Data Science <!-- Put the link to this slide here so people can follow --> slide: https://hackmd.io/@ericmjl/software-ds --- ## Who am I? - 📍 Principal Data Scientist, DSAI, Moderna - 🎓 ScD, MIT Biological Engineering. - 🧬 Inverse protein, mRNA, and small molecule design --- ## Lessons from work 1. 🤝 We collaborate. 2. 📦 Our stuff needs to be portable. > Data science is no longer solo work, but teamwork. The corollary is this: discipline enables better collaborative work. --- ## What do these lessons imply for _how_ we need to work? ---- ### 🤝 Collaborative implies sharing - Any teammate must be able to jump onto any another project easily. - Highly standardized workflows, tools, and idioms. - Zero ambiguity required when talking about data and code. How do we enable these? ---- ### 📄 Project structure templates - All projects are initialized **identically**. - Customizations happen afterwards. - Common customizations are upstreamed. ---- ### 🛠 PyDS-CLI ![](https://i.imgur.com/RfnZ6yJ.jpg) ---- ### 🛠 CCDS ![](https://i.imgur.com/XA7FFqm.jpg) ---- ### ✅ Truthy - Code is versioned with git and packaged up. - Data is versioned separately with git-like hashes. - Analysis code always references specific data hash. ---- ### 0️⃣-ambiguity data loading ```python from custom_source import load_data df = load_data(commit="5j39fdm") ``` 💯% reproducible. ---- ### 👍 Single Source of Truth Avoid this conversation: > "Which version of that function were you talking about? The one in `Untitled12.ipynb`?" > "No, the one in `Untitled13.ipynb`!" ---- Inside `custom_source/functions.py`: ```python def that_function(): return stuff ``` ---- Inside `Untitled12.ipynb`: ```python from custom_source.functions import that_function ``` Inside `Untitled13.ipynb`: ```python from custom_source.functions import that_function ``` ---- ### ✅ Verify Correctness If you modify a function that others depend on, it should still work for the existing use cases. ```python import pytest from custom_source.functions import that_function def test_that_function(): result = that_function() assert result == something_correct ``` ---- ### ✅ Verify Correctness If you create, modify, and return dataframes, make sure that they follow expectations. ```python import pandera as pa from custom_source.schemas import this_schema @pa.check_output(this_schema) def load_data(commit): ... return df ``` ---- ### 💻 Portable > But the code works on my system?! But if it doesn't work on someone else's system...? ---- ### 🧠 Complexity 😫 **Problem:** most projects have a complex set of dependencies that aren't covered by one tool (e.g. `pip`). ---- ### 🧠 Complexity 😇 **Solution:** Explicitly specify all dependencies via configuation files: - `environment.yml` or `requirements.txt` for project dependencies - `Dockerfile` for system-level dependencies. ---- ### 📦 Containers Containers let you ship dependency stack _explicitly_. ```Dockerfile # Explicit version number! # Standardize on some base image. FROM condaforge/mambaforge:4.12.0-0 # Signal to next person that the project needs a `conda` environment. COPY environment.yml /tmp/environment.yml # Never deal with custom environment names in a Docker container. # Always install to base. RUN mamba env update -f /tmp/environment.yml -n base # add additional steps below. ``` ---- ### ☁️ Cloud - ✅ Treat your dev system like livestock 🐮. - ❎ Don't treat your dev system like pets 🐶. - ✅ Your laptop can be your pet 🐶 and a glorified chromebook. - ❎ Your laptop shouldn't be your dev system. Work on the cloud. Create/destroy instances at will. Learn how to recreate environments. That will force portability. ---- ### 💯% Remote ☁️ Development ![](https://i.imgur.com/7zTayuL.jpg) ---- ### 📒 Documentation Good project documentation enables others to quickly gain context. Your future self will thank you. ---- ### 📒 Documentation ![](https://diataxis.fr/_images/diataxis.png) <small>Image credit: diataxis.fr</small> --- ## 🧠 Mental Models 1. Standardize practices and tooling. 2. Test your code. 3. Document your work. 4. Reference single & explicit sources of truth. These will enable you to collaborate effectively and ship your work productively. --- ## Thank you --- ## Resources - [Data Science Bootstrap Notes](https://ericmjl.github.io/data-science-bootstrap-notes/get-bootstrapped-on-your-data-science-projects/) - [Everything gets a package](https://ericmjl.github.io/blog/2022/3/31/everything-gets-a-package-yes-everything-gets-a-package/) - [Python Packages](https://py-pkgs.org) - [Big Book of Python](https://www.bigbookofpython.com) - [Diataxis Framework](https://diataxis.fr)

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully