Corrected some comments in the .py and added a section about good practices...

Corrected some comments in the .py and added a section about good practices for coding in the .ipynb

binary_classification_workflow.py

@@ -3,7 +3,7 @@
 Spyder Editor
 
 This file contains the preprocessing functions needed to clean 
-and prepare the data. We first consider the data related to kidney diseases.
+and prepare the data.
 """
 
 import seaborn as sns
@@ -19,6 +19,7 @@ from sklearn.metrics import f1_score
 
 
 """
+kideney data
 data description : 25 features  ( 11  numeric ,14  nominal)
     Numerical Data (11):
         1. age: Age in years
@@ -395,7 +396,8 @@ def split(df, target,alpha=0.2,n=5):
 
 def convert_categorical_feats(df, categorical_cols):
     """
-    Encode the categorical features of the dataset using OrdinalEncoder and OneHotEncoder.
+    Encode the categorical features of the dataset using OrdinalEncoder 
+    and OneHotEncoder.
 
     Parameters:
     ----------

draft_kidney.ipynb

@@ -941,7 +941,9 @@
   {
    "cell_type": "code",
    "execution_count": 16,
-   "metadata": {},
+   "metadata": {
+    "scrolled": true
+   },
    "outputs": [
     {
      "name": "stderr",
@@ -1039,11 +1041,99 @@
    "source": [
     "display_results(dict_models, X_train, y_train, X_test, y_test, cv, 'f1 scoring on Kidney data(%)')"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Code good practices"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Programming is not just about writing code that works; it's also about writing code that is maintainable, readable, and efficient. Good programming practices contribute to the overall quality of code, making it easier to understand, modify, and collaborate on. Here are some essential good programming practices that we tried to follow in our work."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Code redability"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "- Use meaningful variable and function names: Choose names that clearly convey the purpose of the variable or function.\n",
+    "- Maintain consistent line length: try to avoid lines longer than 80-120 characters"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Modularity "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "- Break code into functions or classes: Divide your code into smaller, reusable modules. This promotes code reuse and makes it easier to understand."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Comments and documentation "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "- Write clear comments: Use comments to explain complex logic, assumptions, or any non-obvious aspects of your code.\n",
+    "- Provide documentation: Include docstrings to describe the purpose, parameters, and return values of functions or methods."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "###  Other good practices"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "- Implement proper error handling: Anticipate and handle exceptions gracefully to prevent unexpected crashes.\n",
+    "- Use version control systems (e.g., Git): Keep track of changes, collaborate with others, and easily revert to previous versions if needed.\n",
+    "- Optimize when necessary: Identify bottlenecks and optimize critical sections of your code. However, prioritize readability over premature optimization."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Conclusion "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Adhering to good programming practices is crucial for writing code that is not only functional but also maintainable, scalable, and collaborative. By following these practices, you contribute to the creation of high-quality software that stands the test of time. Remember, writing code is not just about solving a problem; it's about solving it in the best possible way."
+   ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -1057,7 +1147,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.11.3"
   }
  },
  "nbformat": 4,