This PR adds detailed documentation for the data loading methods in the src/galactic/loaders.py file to the README.md file. The documentation includes explanations of each method's functionality, the parameters it takes, and examples of how to use it. Additionally, a brief explanation of the purpose of the src/galactic/loaders.py file is provided at the beginning of the "Loading Data" section.
Summary of Changes
Added a brief explanation of the purpose of the src/galactic/loaders.py file at the beginning of the "Loading Data" section.
Added detailed explanations and examples for each data loading method in the "Loading Data" section:
from_csv: Loads data from a CSV file.
from_jsonl: Loads data from a JSONL file.
from_pandas: Loads data from a Pandas DataFrame.
from_hugging_face: Loads data from the Hugging Face datasets library.
from_hugging_face_stream: Loads streaming data from the Hugging Face datasets library.
from_disk: Loads data from disk using the Hugging Face datasets library.
Updated the "Loading Data" section to provide a comprehensive guide on how to use the data loading methods in the src/galactic/loaders.py file.
Fixes #1.
To checkout this PR branch, run the following command in your terminal:
git checkout sweep/add-documentation-loaders
š Latest improvements to Sweep:
Getting Sweep to run linters before committing! Check out Sweep Sandbox Configs to set it up.
Added support for self-hosting! Check out Self-hosting Sweep to get started.
[Self Hosting] Multiple options to compute vector embeddings, configure your .env file using VECTOR_EMBEDDING_SOURCE
š” To get Sweep to edit this pull request, you can:
Leave a comment below to get Sweep to edit the entire PR
Leave a comment in the code will only modify the file
Edit the original issue to get Sweep to recreate the PR from scratch
Description
This PR adds detailed documentation for the data loading methods in the
src/galactic/loaders.pyfile to theREADME.mdfile. The documentation includes explanations of each method's functionality, the parameters it takes, and examples of how to use it. Additionally, a brief explanation of the purpose of thesrc/galactic/loaders.pyfile is provided at the beginning of the "Loading Data" section.Summary of Changes
src/galactic/loaders.pyfile at the beginning of the "Loading Data" section.from_csv: Loads data from a CSV file.from_jsonl: Loads data from a JSONL file.from_pandas: Loads data from a Pandas DataFrame.from_hugging_face: Loads data from the Hugging Face datasets library.from_hugging_face_stream: Loads streaming data from the Hugging Face datasets library.from_disk: Loads data from disk using the Hugging Face datasets library.src/galactic/loaders.pyfile.Fixes #1.
To checkout this PR branch, run the following command in your terminal:
š Latest improvements to Sweep:
š” To get Sweep to edit this pull request, you can: