Skip to content

DOC: README updates#7

Merged
nray merged 1 commit intomainfrom
treddy_basic_readme
Jan 22, 2026
Merged

DOC: README updates#7
nray merged 1 commit intomainfrom
treddy_basic_readme

Conversation

@tylerjereddy
Copy link
Collaborator

  • Our README hasn't been updated in quite a while, so this patch aims to make it more relevant and useful, especially now that we are public-facing and looking to onboard more folks soon.

  • Use the new/proper title of the project at the top of the README and include the official LANL FCI copyright O# at the top as they request.

  • Add a brief introduction that describes what our library provides.

  • Add some contributor guidelines--feel free to suggest improvements/changes if you disagree, etc.

* Our `README` hasn't been updated in quite a while, so this
patch aims to make it more relevant and useful, especially now
that we are public-facing and looking to onboard more folks soon.

* Use the new/proper title of the project at the top of the `README`
and include the official LANL FCI copyright O# at the top as they
request.

* Add a brief introduction that describes what our library provides.

* Add some contributor guidelines--feel free to suggest
improvements/changes if you disagree, etc.
@tylerjereddy tylerjereddy added the documentation Improvements or additions to documentation label Jan 17, 2026
2. At the moment it is not acceptable to use machine learning/AI/LLMs as
part of the code contribution/review process. The reason is related to provenance
and licensing---we cannot know for sure if the material being contributed
originated or partially originated from code that had a copyleft license.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some thoughts here:

  1. I certainly think this is true for our open code.
  2. There may be exceptions--particularly interesting is the usage of LLMs that have provably been trained on license-compatible code sources. I'm not in the loop on whether there are good options here. If there are, that might be neat since we could use them to help with code review, but stuff like copilot (the GitHub default PR helper) is almost certainly not safe.
  3. It may be interesting to think about what our stance might be for the research/in-house/private code. If we want to share it widely it may very well have the same problem. Conversely, if our only intention with the research code is to allow others to reproduce the work/experiments, but it isn't meant for wide adoption like the library code, we could potentially use LLM assistants in the code review interface (which is nice...). That's probably a tough call, and something we can discuss elsewhere.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I am unclear how to verify if an LLM has been trained on license compatible codes. For example, ChatGPT would tell you internal method details of GrafoRVFL even though it is copy left.

3. Please make an effort to format your PR titles and commit messages
according to the [guidelines used provided by NumPy](https://numpy.org/devdocs/dev/development_workflow.html#writing-the-commit-message). This helps keep our commit
history readable and easier to debug.
4. Please try to avoid merging your own code---we aim to provide timely
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An example is here: https://github.com/lanl/ascr_rvfl/pull/65#issuecomment-3764454861

While that doesn't matter much in that particular case, as a general policy let's just try to avoid merges until all comments are fully addressed to reduce the likelihood that things slip through and then i.e., I end up cleaning it up myself, etc..

machine learning estimators that do not use backpropagation. The most
prominent estimator types we support provide access to single and multi layer
random vector functional link (RVFL) networks and extreme learning machines
(ELMs). There is a considerable background literate on these two types
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: "literate" --> "literature"

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a few references to the implemented architectures ? Or, do we wait till the vision paper is out and then update the readme with that.

2. At the moment it is not acceptable to use machine learning/AI/LLMs as
part of the code contribution/review process. The reason is related to provenance
and licensing---we cannot know for sure if the material being contributed
originated or partially originated from code that had a copyleft license.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I am unclear how to verify if an LLM has been trained on license compatible codes. For example, ChatGPT would tell you internal method details of GrafoRVFL even though it is copy left.

@nray nray merged commit 13ee05d into main Jan 22, 2026
6 checks passed
@nray nray deleted the treddy_basic_readme branch January 22, 2026 20:31
@tylerjereddy tylerjereddy added this to the 0.1.0 milestone Jan 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants