Skip to content

Commit 1b768fe

Browse files
committed
rename docs and contributing
1 parent dbf06b9 commit 1b768fe

3 files changed

Lines changed: 31 additions & 31 deletions

File tree

CONTRIBUTING.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ In line with our aim, we identify the following themes:
1717
time series analysis,
1818
or even images (e.g. dimensions, EXIF).
1919

20-
_Related_: [#7][i7], [#129][i129], [#190][i190], [#204][i204] or [create one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose).
20+
_Related_: [#7][i7], [#129][i129], [#190][i190], [#204][i204] or [create one](https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/new/choose).
2121

2222
- **Stability, Performance and Restricted environment compatibility:**
2323
Data exploration takes place in all kinds of conditions, on the latest machine learning platforms with enormous dataset to managed environments in large corporations.
24-
`data-profiling` helps analysts, researchers and engineers alike in these cases.
24+
`fg-data-profiling` helps analysts, researchers and engineers alike in these cases.
2525
We do this by fixing bugs, improving performance on big datasets and adding environment compatibility.
2626

2727
_Suggestions for contribution (Performance)_:
28-
Perform concurrency analysis or profile execution times and leverage the gained insights for improved performance (e.g. multiprocessing, cython, numba) or test the performance of `data-profiling` with [big data sets](https://www.stats.govt.nz/large-datasets/csv-files-for-download/) and corresponding commonly used data formats (such as parquet).
28+
Perform concurrency analysis or profile execution times and leverage the gained insights for improved performance (e.g. multiprocessing, cython, numba) or test the performance of `fg-data-profiling` with [big data sets](https://www.stats.govt.nz/large-datasets/csv-files-for-download/) and corresponding commonly used data formats (such as parquet).
2929

3030
_Suggestions for contribution (Stability)_:
31-
Either review the code and add tests or watch the [issues page](https://github.com/Data-Centric-AI-Community/data-profiling/issues) and [Stackoverflow tag](https://stackoverflow.com/questions/tagged/ydata-profiling) to find current issues.
31+
Either review the code and add tests or watch the [issues page](https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues) and [Stackoverflow tag](https://stackoverflow.com/questions/tagged/ydata-profiling) to find current issues.
3232

33-
_Related_: [#98][i98], [#122][i122] or [create one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose).
33+
_Related_: [#98][i98], [#122][i122] or [create one](https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/new/choose).
3434

3535
- **Interaction, presentation and user experience**:
36-
As `data-profiling` eases exploratory data analysis, working with the package should reflect that.
36+
As `fg-data-profiling` eases exploratory data analysis, working with the package should reflect that.
3737
Interaction and user experience plays a central role in working with the package.
3838
Working on interactive and static features is possible through the modular nature of the package: the user can configure which features to use.
3939

@@ -46,30 +46,30 @@ In line with our aim, we identify the following themes:
4646
Other forms of distribution than HTML (for example PDF or packaged as an GUI application via [PyQt](https://riverbankcomputing.com/software/pyqt/intro))
4747
Users should be able to share reports (improve size of labels in graph, add explanations to correlation matrices and allow for styling/branding).
4848

49-
_Related_: [#161][i161], [#175][i175], [#191][i191] or [create one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose).
49+
_Related_: [#161][i161], [#175][i175], [#191][i191] or [create one](https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/new/choose).
5050

5151
- **Community**:
5252
The success of this package demonstrates the power of sharing and working together.
5353
You are welcome as part of this community.
5454

5555
_Suggestions for contribution_:
5656
Share with us if this package is of value to you, let us know [in our community](https://discord.com/invite/mw7xjJ7b7s).
57-
We are interested in how you use `data-profiling` in your work.
57+
We are interested in how you use `fg-data-profiling` in your work.
5858

59-
_Related_: [#87][i87] or [create one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose).
59+
_Related_: [#87][i87] or [create one](https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/new/choose).
6060

6161
- **Machine learning:**
62-
`data-profiling` is not a machine learning package, even though many of our users use EDA as a step prior to developing their models.
62+
`fg-data-profiling` is not a machine learning package, even though many of our users use EDA as a step prior to developing their models.
6363
Our focus lies in the exploratory data analysis.
6464
Any functionality that enables machine learning applications by more effective data profiling, is welcome.
6565

66-
_Related_: [#124][i124], [#173][i173], [#198][i198] or [create one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose).
66+
_Related_: [#124][i124], [#173][i173], [#198][i198] or [create one](https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/new/choose).
6767

6868
#### **Did you find a bug?**
6969

70-
* **Ensure the bug was not already reported** by searching on Github under [Issues](https://github.com/Data-Centric-AI-Community/data-profiling/issues).
70+
* **Ensure the bug was not already reported** by searching on Github under [Issues](https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues).
7171

72-
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Data-Centric-AI-Community/data-profiling/issues/new/choose).
72+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/new/choose).
7373
If possible, use the relevant bug report templates to create the issue.
7474

7575
#### **Did you write a patch that fixes a bug?**
@@ -84,19 +84,19 @@ Include the relevant issue number if applicable.
8484

8585
We would like to thank everyone who has helped getting us to where we are now.
8686

87-
See the [Contributor Graph](https://github.com/Data-Centric-AI-Community/data-profiling/graphs/contributors)
88-
89-
[i7]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/7
90-
[i129]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/129
91-
[i190]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/190
92-
[i204]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/204
93-
[i98]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/98
94-
[i122]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/122
95-
[i124]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/24
96-
[i173]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/173
97-
[i198]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/198
98-
[i87]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/87
99-
[i161]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/161
100-
[i175]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/175
101-
[i191]: https://github.com/Data-Centric-AI-Community/data-profiling/issues/191
87+
See the [Contributor Graph](https://github.com/Data-Centric-AI-Community/fg-data-profiling/graphs/contributors)
88+
89+
[i7]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/7
90+
[i129]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/129
91+
[i190]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/190
92+
[i204]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/204
93+
[i98]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/98
94+
[i122]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/122
95+
[i124]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/24
96+
[i173]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/173
97+
[i198]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/198
98+
[i87]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/87
99+
[i161]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/161
100+
[i175]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/175
101+
[i191]: https://github.com/Data-Centric-AI-Community/fg-data-profiling/issues/191
102102

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: "YData Profiling"
2-
repo_url: https://github.com/Data-Centric-AI-Community/data-profiling
3-
repo_name: Data-Centric-AI-Community/data-profiling
2+
repo_url: https://github.com/Data-Centric-AI-Community/fg-data-profiling
3+
repo_name: Data-Centric-AI-Community/fg-data-profiling
44
dev_addr: 0.0.0.0:1235
55
site_dir: static/docs
66
nav:

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ unicode= [
133133

134134
[project.urls]
135135
Homepage = "https://ydata.ai"
136-
Repository = "https://github.com/Data-Centric-AI-Community/data-profiling"
136+
Repository = "https://github.com/Data-Centric-AI-Community/fg-data-profiling"
137137

138138
[project.scripts]
139139
data_profiling = "data_profiling.controller.console:main"

0 commit comments

Comments
 (0)