-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6d30f5f
commit bf54ce9
Showing
19 changed files
with
274 additions
and
5 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| .idea/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
||
| # What Is CRSIP-DM? | ||
|
|
||
| A brief explanation was provided [here](../README.MD#Table-Of-Contents) | ||
|
|
||
| # How To Print This Documentation | ||
|
|
||
| If you wish to have this documentation printed to PDF, you can use [GRIP](https://gist.github.com/justincbagley/ec0a6334cc86e854715e459349ab1446) to convert the markdown files for you. It looks like [Atom has a similar feature](https://superuser.com/a/722374) as well. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
||
| TBD |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
||
| TBD |
38 changes: 38 additions & 0 deletions
38
Docs/CRISP-DM/docs/1_business_understanding/1_Business_Objectives.MD
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
||
| # PROJECTNAME Business Objectives | ||
| - [Background](#background) | ||
| - [Business Climate](#business-climate) | ||
| - [Business Problem Statement](#business-problem-statement) | ||
| - [Business Objectives](#business-objectives) | ||
| - [Business Success Criteria](#business-success-criteria) | ||
|
|
||
| ## Background | ||
|
|
||
| TBD | ||
|
|
||
| ## Business Climate | ||
|
|
||
| TBD | ||
|
|
||
| ## Business Problem Statement | ||
|
|
||
| TBD | ||
|
|
||
| ## Business Objectives | ||
|
|
||
| TBD | ||
|
|
||
| ## Business Success Criteria | ||
|
|
||
| TBD | ||
|
|
||
| ### Functionality Criteria | ||
|
|
||
| The solution should: | ||
|
|
||
| - TBD | ||
|
|
||
| Opportunities for business value include: | ||
|
|
||
| 1. TBD |
63 changes: 63 additions & 0 deletions
63
Docs/CRISP-DM/docs/1_business_understanding/2_Situation.MD
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
||
| # Situation | ||
|
|
||
| - Inventory Of Resources | ||
| - Requirements, Assumptions, & Constraints | ||
| - Risks & Contingencies | ||
| - Terminology | ||
| - Costs & Benefits | ||
|
|
||
| ## Inventory Of Resources | ||
|
|
||
| ### People Resources | ||
|
|
||
| #### Executive Leadership | ||
|
|
||
| | Name | Email | Phone | | ||
| | --- | :---: | :---: | | ||
| | NA | NA | NA | | ||
|
|
||
| #### Current Project Team | ||
|
|
||
| | Name | Email | Phone | Project Role | Availability<br>hr/week | Location | Notes | | ||
| | --- | :---: | :---: | :---: | :---: | :---: | --- | | ||
| | Kassandra Keeton | [LinkedIn](https://linkedin.com/in/kkeeton/) | Python Mentor, Data Science Ambassador | Lead Developer | Flexible | TX, USA | TBD | | ||
|
|
||
| #### Programming Resources | ||
|
|
||
| | Name | Email | Phone | Project Role | Availability<br>hr/week | Location | Notes | | ||
| | --- | :---: | :---: | :---: | :---: | :---: | --- | | ||
| | Kassandra Keeton | [LinkedIn](https://linkedin.com/in/kkeeton/) | Python Mentor, Data Science Ambassador | Lead Developer | Flexible | TX, USA | TBD | | ||
|
|
||
| #### Prior Project Team | ||
|
|
||
| | Name | CEC | Cisco Role | Project Role | Availability<br>hr/week | Location | Notes | | ||
| | --- | :---: | :---: | :---: | :---: | :---: | --- | | ||
| | TBD | | | | | | | | ||
|
|
||
| ### Data Resources | ||
|
|
||
| | Name | Email | Phone | Project Role | Availability<br>hr/week | Location | Notes | | ||
| | --- | :---: | :---: | :---: | :---: | :---: | --- | | ||
| | Kassandra Keeton | [LinkedIn](https://linkedin.com/in/kkeeton/) | Python Mentor, Data Science Ambassador | Lead Developer | Flexible | TX, USA | TBD | | ||
|
|
||
| More information can be found in the [Data Understanding](../2_data_understanding/README.MD) section of this CRISP-DM documentation and the [datasets](../../datasets) subfolder of the git repo. | ||
|
|
||
| TBD | ||
|
|
||
| ## Requirements, Assumptions, & Constraints | ||
|
|
||
| TBD | ||
|
|
||
| ## Risks & Contingencies | ||
|
|
||
| TBD | ||
|
|
||
| ## Terminology | ||
|
|
||
| TBD | ||
|
|
||
| ## Costs & Benefits | ||
|
|
||
| TBD |
2 changes: 2 additions & 0 deletions
2
Docs/CRISP-DM/docs/1_business_understanding/3_Data_Mining_Goals.MD
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
2 changes: 2 additions & 0 deletions
2
Docs/CRISP-DM/docs/1_business_understanding/4_Project_Plan.MD
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
||
| # Cross-Skilling Business Understanding | ||
|
|
||
| 1. [Business Objectives](1_Business_Objectives.MD) | ||
|
|
||
| The Business Objectives specifies the following: | ||
|
|
||
| - the background | ||
| - business climate | ||
| - business problem statement | ||
| - business objectives | ||
| - business success criteria | ||
|
|
||
| 2. [Situation](2_Situation.MD) | ||
|
|
||
| The situation section identifies: | ||
|
|
||
| - the inventory of resources | ||
| - requirements | ||
| - assumptions | ||
| - constraints | ||
| - risks and contingencies | ||
| - terminology | ||
| - costs & benefits | ||
|
|
||
| 3. [Data Mining Goals](3_Data_Mining_Goals.MD) | ||
|
|
||
| The Data Mining Goals specifies Data Mining objectives & success criteria. | ||
|
|
||
| 4. [Project Plan](4_Project_Plan.MD) | ||
|
|
||
| The Project Plan specifies the Project Plan, Assessment of Tools, and Techniques. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Each line is a file pattern followed by one or more owners. | ||
|
|
||
| # These owners will be the default owners for everything in | ||
| # the repo. Unless a later match takes precedence, | ||
| # @global-owner1 and @global-owner2 will be requested for | ||
| # review when someone opens a pull request. | ||
| * @prosperousheart | ||
|
|
||
| # ------------------------------------------------------------------------------ | ||
| # The rest of this is for information on how to update in the future: | ||
| # https://help.github.com/en/enterprise/2.14/user/articles/about-code-owners | ||
| # ------------------------------------------------------------------------------ | ||
|
|
||
| # Order is important; the last matching pattern takes the most | ||
| # precedence. When someone opens a pull request that only | ||
| # modifies JS files, only @js-owner and not the global | ||
| # owner(s) will be requested for a review. | ||
| # *.js @js-owner | ||
|
|
||
| # You can also use email addresses if you prefer. They'll be | ||
| # used to look up users just like we do for commit author | ||
| # emails. | ||
| # *.go [email protected] | ||
|
|
||
| # In this example, @doctocat owns any files in the build/logs | ||
| # directory at the root of the repository and any of its | ||
| # subdirectories. | ||
| # /build/logs/ @doctocat | ||
|
|
||
| # The `docs/*` pattern will match files like | ||
| # `docs/getting-started.md` but not further nested files like | ||
| # `docs/build-app/troubleshooting.md`. | ||
| # docs/* [email protected] | ||
|
|
||
| # In this example, @octocat owns any file in an apps directory | ||
| # anywhere in your repository. | ||
| # apps/ @octocat | ||
|
|
||
| # In this example, @doctocat owns any file in the `/docs` | ||
| # directory in the root of your repository. | ||
| # /docs/ @doctocat |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
||
| # CRISP-DM For PROJECTNAME | ||
|
|
||
| This docs section will provide information on the planning, resources, needs, timeline, and more regarding the needs of this project. | ||
|
|
||
| # Sections | ||
|
|
||
| 1. [Business Understanding](1_business_understanding/README.MD) | ||
|
|
||
| Business understanding documents the project objectives & requirements from a business perspective, the data mining definition, and a preliminary plan. | ||
|
|
||
| 2. [Data Understanding](2_data_understanding/README.MD) | ||
|
|
||
| Data Understanding documents the datasets acquired, their locations, methods used to acquire them, and any problems encountered - including how they were resolved. | ||
|
|
||
| 3. [Data Preparation](3_data_preparation/README.MD) | ||
|
|
||
| Data Preparation documents the process of cleaning the data, including what decisions and actions were taken to address the data quality problems raised in the Data Understanding phase. | ||
|
|
||
| 4. [Modeling](4_modeling/README.MD) | ||
|
|
||
| Modeling documents the results of selecting modeling techniques, generating test designs, building models, and assessing models. | ||
|
|
||
| 5. [Evaluation](5_evaluation/README.MD) | ||
|
|
||
| Evaluation documents the results of evaluating results, reviewing process, and determining next steps. | ||
|
|
||
| 6. [Deployment](6_deployment/README.MD) | ||
|
|
||
| Deployment specifies the deployment of the data mining results. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| <a href='https://www.learntocodeonline.com/'></a> | ||
|
|
||
| # Explanation Of Docs | ||
|
|
||
| Since we're in the [cheatsheets](../) portion of [my GitHub](https://github.com/ProsperousHeart), I decided to create a section for documentation templates. | ||
|
|
||
| The more I learn on my journey as a computer scientist / data scientist, the more I find it beneficial to simply just have an empty template for my different projects & documentation. | ||
|
|
||
| Why reinvent the wheel, right? | ||
|
|
||
| # Table Of Contents | ||
|
|
||
| 1. [CRISP-DM](CRISP-DM): "Cross-Industry Standard Process for Data Mining" | ||
|
|
||
| According to [the IBM Knowledge Center](https://www.ibm.com/support/knowledgecenter/en/SS3RA7_15.0.0/com.ibm.spss.crispdm.help/crisp_overview.htm), this "is an industry-proven way to guide your data mining efforts" - and quite frankly? It makes the organizer in me VERY happy! | ||
|
|
||
| <a href="https://www.ibm.com/support/knowledgecenter/en/SS3RA7_15.0.0/com.ibm.spss.crispdm.help/crisp_overview.htm"><img align="middle" src="https://www.ibm.com/support/knowledgecenter/SS3RA7_15.0.0/com.ibm.spss.crispdm.help/images/crisp_process.gif"></img></a> | ||
|
|
||
| As a **methodolody** it includes: | ||
| - descriptions of the typical phases of a project | ||
| - tasks involved with each phase | ||
| - an explanation of the relationships between tasks | ||
|
|
||
| As a **process model**: | ||
| - provides an overview of the data mining life cycle | ||
|
|
||
| By following this process, you are able to create a data mining model that fits your particulat needs. | ||
|
|
||
| I have taken what I have learned & crafted my own blank template inside of this section. Including but not limited to: | ||
| - [folder structure](CRISP-DM/README.MD) for future code projects | ||
| - [fluid documentation](CRISP-DM/docs) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters