Skip to main content

This is a package that helps data scientists and data analysts to capture notes while they work through data science tasks. The captured tasks can then be searched and analyzed.

Project description

DOI License Documentation Status

Knowledge Management for Data Science

What is this tool used for?

This tool is used for knowledge management in data science. In software design, conceptual domain models inform lower-level models. In data science work, experiments yield knowledge that informs modeling choices. Data science models are almost always informed by a variety of analysis experiments. Experimentation and organization of knowledge artifacts supporting modeling decisions is a requirement for reproducible data science models and improving model quality and performance.

Please see knowledge application development context for a description of a typical knowledge application development setting.

Why do you need this tool?

The above narrative suggests that ability to retrieve knowledge about experiments and historical models in an adhoc manner is critical in data science. It is. It is also grossly underserved. Knowledge management tools for domain specific models exist, knowledge management tools for dev-ops and ML-Ops exist, but tools for analytics and model development are siloed. Information gets fragmented over time. So analysts and data scientists often have to go to experiment tools, data catalogs or ML-Ops tools to fetch information they need to develop a model. In a subsequent iteration of this model, the contextual information that informed the development of this model is often lost, and the development team, possibly with new team members, have the task of reconstructing this contextual information again. This library is a step in fixing this problem. The central idea is to organize tasks in terms of a sequence of steps that are pretty standard in data analysis work and capture knowledge in context while these tasks are performed.

How is it related to process guidelines and vocabularies for machine learning?

Initiatives such as CRISP DM provide guidelines and processes for developing data science projects. Projects such as Open ML provide semantic vocabulary standardization for machine learning tasks. These are excellent tools. However, the guidelines they provide are task focussed. The gap between a conceptual idea and the final, or, even candidate data science tasks for a project is filled with many assumptions and experimental evaluations. The information in these assumptions and experimental evaluations is what this tool aims to capture. There is also an ordering to these assumptions and experimental evaluations. This is also what this tool aims to capture.

Who would use this tool?

This tool is for data scientists and data analysts.

How do you use this tool?

  1. You install this library along with the other python dependecies you need for your analysis task
  2. Review the basic recipe for capturing your observations.
  3. Review the templates section to find the example relevant to you. For analytics projects, review the analytics template. For machine learning projects, review the machine learning template.
  4. Start using the tool in your projects using the information from your review of the above two steps.

Licensing and Feature Questions

  1. The tool is open source with an apache 2.0 license

  2. If you are interested in the following features, please set up a meeting with me:

    1. Help with a data analysis task for your use case
    2. Developing an ontology based solution similar to the above for your specific use case.
    3. Customizing this tool with other extensions, for example to integrate a feature store or meta-data management tool that you use in your data science tool stack.
  3. If this problem resonates with you as a developer and you would like to contribute, submit an issue and if the feature makes sense we can discuss the possiblity of submitting a PR for it. Of course, you can fork this repository and use it per the licensing information. Thank you for your interest.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kmds-0.2.12.tar.gz (5.6 MB view hashes)

Uploaded Source

Built Distribution

kmds-0.2.12-py3-none-any.whl (5.8 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page