Remove readme maintainer
article thumbnail

Architecture.md (2021)

Hacker News

If you maintain an open-source project in the range of 10k-200k lines of code, I strongly encourage you to add an ARCHITECTURE document next to README and CONTRIBUTING. Before going into the details of why and how, I want to emphasize that this is not another docs are good, write more docs advice.

83
article thumbnail

How to make data science projects more open and inclusive

DrivenData Labs

Include a README that explains what your project does in plain, non-technical language. Example Team Spatial Clan wrote an excellent README to accompany their winning solution in the Pale Blue Dot challenge, which studies the impact of natural disasters on food insecurity in Kenya.

professionals

Sign Up for our Newsletter

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

article thumbnail

Generate customized, compliant application IaC scripts for AWS Landing Zone using Amazon Bedrock

AWS Machine Learning Blog

These are delivered through pipelines to a Terraform private module registry, which is maintained by the organization for consistency and standardization. Second, create a detailed README file. For example: “Generate a detailed README for the Terraform configuration based on AWS services.

AWS 98
article thumbnail

How to Organize Your Data Science Project: A Comprehensive Guide

Mlearning.ai

Make sure to include a README file specifying the data sources, formats, and any preprocessing steps performed. Organizing scripts based on functionality enhances code reusability and maintainability. Include a README file that explains the model architecture, hyperparameters, and training details.

article thumbnail

MAANG’s implementation of the 10 Git best practices

Data Science Dojo

Clear naming conventions, logical folder hierarchies, and README files with essential information are implemented consistently across all projects. By following a systematic code review process, MAANG ensures that the codebase maintains a high level of quality and readability.

195
195
article thumbnail

How to Get Slack Data Into Snowflake Using Infrastructure as Code

phData

Prerequisites Please carefully read the required environment prerequisites that are listed in the README. This way, they can be separately maintained but still maintain their various dependencies at a modular level. This helps us to build a secure connection to Slack and ensure data privacy is maintained.

AWS 52
article thumbnail

Deploy self-service question answering with the QnABot on AWS solution powered by Amazon Lex with Amazon Kendra and large language models

AWS Machine Learning Blog

This provides the following advantages: The number of FAQs that you need to maintain and import into QnABot is reduced, because you can now synthesize concise answers on the fly from your existing documents. Review your options from the qnabot-on-aws-plugin-samples repository README. First, choose the plugin LLM you want to use.

AWS 97