Skip to content

(docs): Improve README file for Navi #550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 4, 2023

Conversation

anqueue
Copy link
Contributor

@anqueue anqueue commented Apr 1, 2023

Description

This pull request updates the README file for Navi, making several improvements to its structure and content. First, I have moved the README file from its previous location in a nested folder (navi/navi) to the root folder (navi). This change should make it easier to find and access the file, especially for new users who are not familiar with the project's directory structure.

In addition to the structural changes, I have also made several improvements to the grammar and readability of the document. Specifically, I have corrected grammar mistakes and rephrased several sections for clarity. These changes should make the README more accessible and understandable for all users.

Please let me know if you have any feedback or questions about these changes.

@babuloseo
Copy link

Do you think we should rewrite it all in Python? I am thinking we can get faster code speedup than that language with oxidization, if we try to implement quantum machine learning algorithms instead and essentially build our own quantum computer to do under 5 billion recomms under 1*10^-15 femtoseconds. We will write an AI for our quantum computer that disallows Rusteceans, by having them go through the sorting hat.

@mmattbtw
Copy link

mmattbtw commented Apr 1, 2023

Excellent work or achievement, demonstrating a high degree of proficiency, skill, or mastery in a particular field or endeavor. The results produced are of exceptional quality and surpass the expectations set forth, indicating a level of dedication, expertise, and commitment that is truly remarkable. Such accomplishments deserve recognition and praise, as they represent a significant contribution to the advancement of knowledge, innovation, and progress in a given domain. In short, this is an outstanding accomplishment that reflects a deep understanding and appreciation of the task at hand, as well as a strong desire to excel and achieve excellence.

@cmcdev-code
Copy link

While Python and Rust are both powerful languages, they have different strengths and weaknesses. Rewriting everything in Python may not necessarily lead to faster code speedup compared to Rust, especially if Rust was already chosen for its speed and memory safety.

Moreover, building a quantum computer from scratch is a significant undertaking and requires extensive expertise in quantum physics, computer engineering, and software development. It is not a simple matter of implementing quantum machine learning algorithms and disallowing Rust developers from contributing to the project. Additionally, quantum computers are still in the early stages of development, and it may be challenging to achieve the level of performance you described.

In summary, while it's essential to explore new technologies and approaches, it's crucial to weigh the costs and benefits carefully. Rewriting everything in Python may not necessarily lead to faster performance, and building a quantum computer is a complex and challenging endeavor that requires extensive knowledge and resources.

@CLAassistant
Copy link

CLAassistant commented Apr 1, 2023

CLA assistant check
All committers have signed the CLA.

- `scripts/run_tf2.sh` for [TensorFlow](https://www.tensorflow.org/)
- `scripts/run_onnx.sh` for [Onnx](https://onnx.ai/)

Do note that you need to create a models directory and create some versions, preferably using epoch time, e.g., `1679693908377`.

Choose a reason for hiding this comment

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

Note should be placed before shell files.

@@ -23,12 +23,14 @@ While Navi's features may not be as comprehensive as its open-source counterpart
- `thrift_bpr_adapter`: generated thrift code for BatchPredictionRequest

## Content
We include all *.rs source code that makes up the main navi binaries for you to examine. The test and benchmark code, as well as configuration files are not included due to data security concerns.
We have included all *.rs source code files that make up the main Navi binaries for you to examine. However, we have not included the test and benchmark code, as well as various configuration files, due to data security concerns.

Choose a reason for hiding this comment

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

"as well as" implies conjunction with a positive statement. The correct verbiage here would probably be "or":

However, we have not included the test and benchmark code, or various configuration files, due to data security concerns.

I would also recommend dropping the "the":

However, we have not included test and benchmark code, or various configuration files, due to data security concerns.

The comma between "code" and "or", and "files" and "due", has a panache that draws attention from the next clause. An em dash might be necessary here.

Copy link
Contributor

Choose a reason for hiding this comment

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

agree. will fix in original code and propogate to the open source version.

@dzhao
Copy link
Contributor

dzhao commented Apr 4, 2023

appreciate the suggestion.

@dzhao dzhao merged commit 9f0afc0 into twitter:main Apr 4, 2023
@byronrode
Copy link

byronrode commented Apr 19, 2023

While Python and Rust are both powerful languages, they have different strengths and weaknesses. Rewriting everything in Python may not necessarily lead to faster code speedup compared to Rust, especially if Rust was already chosen for its speed and memory safety.

Moreover, building a quantum computer from scratch is a significant undertaking and requires extensive expertise in quantum physics, computer engineering, and software development. It is not a simple matter of implementing quantum machine learning algorithms and disallowing Rust developers from contributing to the project. Additionally, quantum computers are still in the early stages of development, and it may be challenging to achieve the level of performance you described.

In summary, while it's essential to explore new technologies and approaches, it's crucial to weigh the costs and benefits carefully. Rewriting everything in Python may not necessarily lead to faster performance, and building a quantum computer is a complex and challenging endeavor that requires extensive knowledge and resources.

Not going to lie, this reads like it was asked via ChatGPT — not saying it was; just pointing out a humorous assumption — and I’m keen to see what prompt it returns when asked to create a prompt from the given answer, ala, Midjourney’s /describe prompt.

@byronrode
Copy link

"Can you provide a summary of the differences between Python and Rust, and the challenges involved in building a quantum computer from scratch? Also, could you touch on the importance of weighing the costs and benefits of exploring new technologies?"

twitter-service pushed a commit that referenced this pull request Apr 28, 2023
-fix corner case where dr converter failed when initializing

Closes #550
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants