Ashish Patel ashishpatel26

UPDATE: I have baked the ideas in this file inside a Python CLI tool called pyds-cli. Please find it here: https://github.com/ericmjl/pyds-cli

How to organize your Python data science project

Having done a number of data projects over the years, and having seen a number of them up on GitHub, I've come to see that there's a wide range in terms of how "readable" a project is. I'd like to share some practices that I have come to adopt in my projects, which I hope will bring some organization to your projects.

Disclaimer: I'm hoping nobody takes this to be "the definitive guide" to organizing a data project; rather, I hope you, the reader, find useful tips that you can adapt to your own projects.

Disclaimer 2: What I’m writing below is primarily geared towards Python language users. Some ideas may be transferable to other languages; others may not be so. Please feel free to remix whatever you see here!

People

`:bowtie:`	😄 `:smile:`	😆 `:laughing:`
😊 `:blush:`	😃 `:smiley:`	☺️ `:relaxed:`
😏 `:smirk:`	😍 `:heart_eyes:`	😘 `:kissing_heart:`
😚 `:kissing_closed_eyes:`	😳 `:flushed:`	😌 `:relieved:`
😆 `:satisfied:`	😁 `:grin:`	😉 `:wink:`
😜 `:stuck_out_tongue_winking_eye:`	😝 `:stuck_out_tongue_closed_eyes:`	😀 `:grinning:`
😗 `:kissing:`	😙 `:kissing_smiling_eyes:`	😛 `:stuck_out_tongue:`

	# Disclamer: This code is not written by me. Its taken from https://github.com/imartinez/privateGPT/pull/91.
	# All credit goes to `vnk8071` as I mentioned in the video.
	# As this code was still in the pull request while I was creating the video, did some modifications so that it works for me locally.

	import gradio as gr
	from langchain.callbacks.streaming_stdout import StreamingStdOutCallbackHandler
	from langchain.chains import RetrievalQA
	from langchain.embeddings import LlamaCppEmbeddings
	from langchain.llms import GPT4All, LlamaCpp
	from langchain.vectorstores import Chroma

	;What does this script do?
	;It's a workaround for broken G910 Logitech keyboards (possibly other keyboards too) whereby some keys occasionally register multiple keystrokes for one kkkkkeypress.
	;The key bug appears because keyboard registers multiple keystrokes in a very short timespan even though you pressed the key only once.
	;This script makes it so the subsequent keystrokes registered in a very short timespan are ignored thus outputing the key only for the first stroke.

	;List all your broken keys between quotes below. I.e. if your broken keys are g and f then the line below shoud be
	;brokenKeys := "gf"
	brokenKeys := "gf"

	/*
	* Academy Engraved LET *
	AcademyEngravedLetPlain
	---------------------
	* Al Nile *
	AlNile
	AlNile-Bold
	---------------------
	* American Typewriter *
	AmericanTypewriter