rdga-4k 1.0.0

rdga_4k: random data generator algorithm for clustering

rdga_4k (Random Data Generator Algorithm for Clustering)

The rdga_4k library generates synthetic datasets tailored for clustering algorithm applications. It provides two core functions, catbird and canard, for customizable dataset generation with support for binary and categorical features.

---

🔥 Features

• Synthetic Data for Clustering: Tailored datasets for clustering algorithm research and testing.
• Flexible Configurations: Supports binary and categorical feature generation.
• Noise and Intersection Control: Fine-tune feature noise and cluster intersections.
• Reproducible Results: Ensure consistency with random seed support.

---

🛠 Installation

Install using pip:

pip install rdga_4k

---

🚀 Usage

Import the library and use the catbird or canard functions to generate datasets:

from rdga_4k import catbird, canard

# Example using catbird
X, y = catbird(
    n_feat=10,
    feat_sig=[3, 2],
    rate=[50, 50],
    lmbd=0.7,
    eps=0.1,
    random_state=42
)

# Example using canard
X, y = canard(
    n_feat=10,
    n_cat=3,
    rate=[50, 50],
    lmbd=5,
    eps=0.2,
    random_state=42
)

---

📜 Functions Overview

catbird

Generates a labeled dataset with binary features based on feature clustering.

Parameters

• n_feat (int): Number of total features. Must be greater than 1.
• feat_sig (list[int]): List of the number of significant features per cluster.
• rate (list[int]): Number of examples per cluster.
• lmbd (float): Intersection factor between features. Default is 0.8.
• eps (float): Noise rate for feature generation. Default is 0.2.
• random_state (int or RandomState, optional): Seed for reproducibility.

Returns

• X (np.ndarray): Binary matrix representing the features.
• y (np.ndarray): Array of cluster labels.

Example

X, y = catbird(n_feat=10, feat_sig=[3, 2], rate=[50, 50], lmbd=0.7, eps=0.1, random_state=42)

---

canard

Generates a labeled dataset with categorical features divided into multiple categories.

Parameters

• n_feat (int): Number of total features. Must be greater than 1.
• n_cat (int): Number of categories for each feature. Must be greater than 1.
• rate (list[int]): Number of examples per cluster.
• lmbd (int): Intersection factor between features. Default is 10.
• eps (float): Noise rate for feature generation. Default is 0.3.
• random_state (int or RandomState, optional): Seed for reproducibility.

Returns

• X (np.ndarray): Matrix of categorical features.
• y (np.ndarray): Array of cluster labels.

Example

X, y = canard(n_feat=10, n_cat=3, rate=[50, 50], lmbd=5, eps=0.2, random_state=42)

---

get_rate

Helper function that generates balanced and unbalanced rate lists for use with catbird or canard.

Parameters

• N (int): Approximate total number of examples. Must be greater than 1.
• k (int): Number of clusters. Must be greater than 1.
• n_min (int): Minimum number of examples per cluster.

Returns

• list: A list with two elements:
  • rate[0]: Balanced rate — equal distribution across clusters.
  • rate[1]: Unbalanced rate — decreasing distribution across clusters.

Example

from rdga_4k import get_rate, catbird

rate = get_rate(N=500, k=3, n_min=20)

# Balanced
X, y = catbird(n_feat=10, feat_sig=[3, 2, 2], rate=rate[0], random_state=42)

# Unbalanced
X, y = catbird(n_feat=10, feat_sig=[3, 2, 2], rate=rate[1], random_state=42)

---

📄 License

This project is licensed under the MIT License.

---

🤝 Contributing

Contributions are welcome! To contribute:

1. Fork the repository.
2. Create a new branch.
3. Commit your changes.
4. Push to the branch.
5. Open a pull request.

For questions or information, feel free to reach out at: [e-mail].

---

👨‍💻 Author

Developed by AQUINO, R. D. G.

---

💬 Feedback

Feel free to open an issue or contact me for feedback or feature requests. Your input is highly appreciated!