Conversation
Summary of ChangesHello @lazarusA, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request finalizes the migration of the 'Synthetic Data Analysis' example from a standalone book chapter project into the core documentation as a new, accessible tutorial. This refactoring improves the organization of examples and ensures they are properly built and presented within the project's documentation. Additionally, it includes a minor update to project dependencies and a small code clarity improvement in an import statement. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request moves a book chapter example into the main documentation as a tutorial. The changes include adding the new tutorial file, updating the documentation build configuration, removing the old project files, and adding a dependency compatibility entry.
My review focuses on the new tutorial file. I've suggested a few improvements for code clarity and quality, such as simplifying a redundant call, using more descriptive variable names, and adopting a more concise function syntax. I also noted the presence of TODO comments in the new tutorial, which should ideally be resolved or tracked as issues before being published as part of the documentation.
| # ### DimensionalData | ||
| using DimensionalData | ||
| mat = Array(Matrix(dfnot)') | ||
| da = DimArray(mat, (Dim{:col}(Symbol.(names(dfnot))), Dim{:row}(1:size(dfnot, 1)))); |
There was a problem hiding this comment.
The dimension names :col and :row are a bit generic. For better clarity and consistency with common practices in DimensionalData.jl, consider using more descriptive names like :variable and :observation. This would make the data structure's intent clearer to readers of the tutorial.
da = DimArray(mat, (Dim{:variable}(Symbol.(names(dfnot))), Dim{:observation}(1:size(dfnot, 1))));
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #228 +/- ##
=======================================
Coverage 50.31% 50.31%
=======================================
Files 27 27
Lines 1932 1932
=======================================
Hits 972 972
Misses 960 960 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
The bookchapter example should go under research as we try to replicate existing science |
|
yes, currently in the menu bar is going there already. Do you mean: we should create a new folder, |
|
Ah I did not see that it already goes there. I think the research folder is a good idea |
|
I will do the new folder 📁. |
continue #216