{"id":15176654,"url":"https://github.com/craftworksgmbh/mldocs","last_synced_at":"2025-10-01T14:32:32.325Z","repository":{"id":57442263,"uuid":"144726838","full_name":"craftworksgmbh/mldocs","owner":"craftworksgmbh","description":"Documentation for the Machine Learning Process","archived":true,"fork":false,"pushed_at":"2018-08-23T12:42:14.000Z","size":23,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-23T02:48:40.655Z","etag":null,"topics":["documentation","keras","machine-learning","sklearn"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/craftworksgmbh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-14T13:50:56.000Z","updated_at":"2023-01-11T11:22:25.000Z","dependencies_parsed_at":"2022-09-26T18:00:34.453Z","dependency_job_id":null,"html_url":"https://github.com/craftworksgmbh/mldocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/craftworksgmbh/mldocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/craftworksgmbh%2Fmldocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/craftworksgmbh%2Fmldocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/craftworksgmbh%2Fmldocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/craftworksgmbh%2Fmldocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/craftworksgmbh","download_url":"https://codeload.github.com/craftworksgmbh/mldocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/craftworksgmbh%2Fmldocs/sbom","scorecard":{"id":307153,"data":{"date":"2025-08-11","repo":{"name":"github.com/craftworksgmbh/mldocs","commit":"2ee3c8cd9a869c7ab423526c705c2a1f5aa1b992"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 0/10 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-17T22:21:36.395Z","repository_id":57442263,"created_at":"2025-08-17T22:21:36.395Z","updated_at":"2025-08-17T22:21:36.395Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276512732,"owners_count":25655450,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-23T02:00:09.130Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","keras","machine-learning","sklearn"],"created_at":"2024-09-27T13:23:12.945Z","updated_at":"2025-10-01T14:32:32.054Z","avatar_url":"https://github.com/craftworksgmbh.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documenting the Machine Learning Process\n\nSupports models following the Sklearn or Keras structure.\n\n\n## Example Usage\n\n```\nfrom mldocs.documentation import Documentation\nfrom sklearn.datasets import load_iris\nfrom sklearn.model_selection import train_test_split\nfrom sklearn.linear_model import LogisticRegression\nfrom sklearn import metrics\n\n\ndf_x, df_y = load_iris(return_X_y=True)\nx_train, x_test, y_train, y_test = train_test_split(df_x, df_y, random_state=0)\n\nlg = LogisticRegression()\nlg.fit(x_train, y_train)\n\ndoc = Documentation(x_train=x_train, y_train=y_train, x_test=x_test, y_test=y_test, model=lg, random_state=0,\n                    metrics={'accuracy': (metrics.accuracy_score, {}), 'precision': (metrics.precision_score, {'average':'micro'})},\n                    save_dir=SAVE_PATH, comment='this is an example usage', problem_kind='classification')\n\ndoc.document()\n\n```\n\n## Output\n\n - Saves train and test data to specified directory as snapshot of training.\n - Saves trained model.\n - Saves settings/parameters/... to json (see below).\n\n```\n{\n  \"timestamp\": \"14-08-2018_14-04-34\",\n  \"dataset\": {\n    \"test\": {\n      \"y_test\": {\n        \"one_hot_encoding\": false,\n        \"features\": [\n          0\n        ],\n        \"class_frequencies\": {\n          \"0\": 13,\n          \"2\": 9,\n          \"1\": 16\n        },\n        \"n_classes\": 3,\n        \"n_rows\": 38,\n        \"n_features\": 1\n      },\n      \"x_test\": {\n        \"n_rows\": 38,\n        \"n_features\": 4,\n        \"features\": [\n          0,\n          1,\n          2,\n          3\n        ]\n      }\n    },\n    \"train\": {\n      \"y_train\": {\n        \"one_hot_encoding\": false,\n        \"features\": [\n          0\n        ],\n        \"class_frequencies\": {\n          \"0\": 37,\n          \"2\": 41,\n          \"1\": 34\n        },\n        \"n_classes\": 3,\n        \"n_rows\": 112,\n        \"n_features\": 1\n      },\n      \"x_train\": {\n        \"n_rows\": 112,\n        \"n_features\": 4,\n        \"features\": [\n          0,\n          1,\n          2,\n          3\n        ]\n      }\n    }\n  },\n  \"model\": {\n    \"kind\": \"LogisticRegression\",\n    \"parameters\": {\n      \"dual\": false,\n      \"fit_intercept\": true,\n      \"verbose\": 0,\n      \"class_weight\": null,\n      \"max_iter\": 100,\n      \"random_state\": null,\n      \"solver\": \"liblinear\",\n      \"n_jobs\": 1,\n      \"intercept_scaling\": 1,\n      \"multi_class\": \"ovr\",\n      \"tol\": 0.0001,\n      \"C\": 1.0,\n      \"warm_start\": false,\n      \"penalty\": \"l2\"\n    }\n  },\n  \"performance\": {\n    \"metrics\": {\n      \"precision\": 0.868421052631579,\n      \"accuracy\": 0.868421052631579\n    },\n    \"pred_time_per_sample_in_sec\": 3.9276323820415294e-06\n  },\n  \"comment\": \"this is an example usage\",\n  \"problem_kind\": \"classification\",\n  \"random_state\": 0\n}\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcraftworksgmbh%2Fmldocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcraftworksgmbh%2Fmldocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcraftworksgmbh%2Fmldocs/lists"}