Design docs for "Construction of Enriched Research Knowledge Graphs and an Interactive User Interface for Project Grants and Research Findings"#66
Conversation
Summary of ChangesHello @tekrajchhetri, 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 introduces a foundational design document that consolidates ideas, requirements, and early explorations for a new system. The system aims to construct enriched research knowledge graphs and provide an interactive user interface for exploring project grants and research findings. It sets clear goals, outlines detailed technical requirements for the knowledge graph, UI, and backend, and defines major task areas to guide future development, ensuring alignment with existing projects and a robust, scalable solution. 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
Activity
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 introduces a high-level design document for the "Construction of Enriched Research Knowledge Graphs" project. The document is well-structured, covering use cases, goals, requirements, and tasks. My feedback focuses on improving the document's clarity and organization. I've provided a few suggestions to address a minor grammatical ambiguity and to enhance the formatting for better readability. Overall, this is a solid design document.
|
|
||
| 3. **Integrate and align with existing cross-project efforts**, including BICAN, BBQS, and Connects. The intent is not to duplicate existing work, but to reuse, connect, and extend shared data, infrastructure, and capabilities across these projects where appropriate. | ||
|
|
||
| **Estimated deadline for completion: June, 30 2026.** |
There was a problem hiding this comment.
The estimated deadline is an important piece of project information, but its current placement feels a bit abrupt and disconnected from the preceding 'Goals' section. To improve the document's structure, consider placing this under a dedicated ### Timeline heading for better organization and visibility.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
|
||
| The following requirements guide the design and implementation of the system. | ||
|
|
||
| ### Knowledge Graph Requirements |
There was a problem hiding this comment.
shouldn't our knowledge graphs be focused on linkml based data models so that we don't always have to use RDF?
There was a problem hiding this comment.
I mean't the final knowledge graphs we generate, be it using LinkML or other technologies, we want it to be RDF-compliant. Will update to make it clear.
There was a problem hiding this comment.
the reason we use linkml is to focus on data models/schemas and its mapping to ontologies (the information space). is rdf a requirement or implicit in our approach for the moment. also requirements should be specific to this issue rather than general brainkb requirements. please read through some of the design docs on dandi, and you will notice a reasonably clear separation of what we want to do (design specificity including flow) clearly stated from how we want to do it (implementation details).
There was a problem hiding this comment.
I intentionally did not include the implementation details and the flow as it's meant for the discussion of the use case and I was thinking of adding the flow and implementation details. But will update it to include all the details.
There was a problem hiding this comment.
perhaps there is too much in this design then and this is too broad. i would focus on design docs for smaller things first (e.g. the work that seemed to have been implemented without design around PIs and their projects and citations) to get better designs out. on dandi, each design doc is a very specific feature. if it gets too broad, it takes a lot of time to iterate.
This PR contains the high-level design docs for "Construction of Enriched Research Knowledge Graphs and an Interactive User Interface for Project Grants and Research Findings"
This is clean version of #65.