Update README.md

README.md

@@ -6,6 +6,10 @@ tags:
 model-index:
 - name: storage/context
   results: []
+datasets:
+- mhenrichsen/context-aware-splits-english
+language:
+- en
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -19,18 +23,28 @@ It achieves the following results on the evaluation set:
 - Loss: 0.0253
 
 ## Model description
+- This model is used to split texts in a context aware way. Used for RAG applications.
+- This model is an adapter for Mistral 7b.
+It uses the Alpaca format:
 
-More information needed
+```
+Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
 
-## Intended uses & limitations
+### Instruction:
+Your task is to segment text into smaller blocks. Split the text where it makes sense and be vary of the context. The ideal split should be close to {WORD_COUNT} words.
 
-More information needed
+### Input:
+Q: Information/File Manager I'm looking for a file manager application which helps to organize a large amount of movies, pictures, music, text documents, databases, audio-books and ebooks. Right now I only use the Finder which doesn't work well, because I really need a function to put single files into multiple categories. Simply using the file system for this creates a confusing nesting of files. A: Depending on the number of categories you require to handle, you could always use a combination of the finder with the built in label functionality, thus a movie can be held in one area (movies directory, for example), but "tagged" as something else. Using smart directories and saved searches you can view your files by a combination of the attributes (location, label, media type) to create custom views. All without purchasing software. Cheap and cheerful, but may be suitable to your needs. A: Maybe use a file manager that supports Open Meta. Or use symbolic links for organizing all your media files. Or even use hardlinked files if you dare.
 
-## Training and evaluation data
+### Response:
+```
+
+Response:
+```
+{'splits': ["Q: Information/File Manager I'm looking for a file manager application which helps to organize a large amount of movies, pictures, music, text documents, databases, audio-books and ebooks. Right now I only use the Finder which doesn't work well, because I really need a function to put single files into multiple categories. Simply using the file system for this creates a confusing nesting of files.", 'A: Depending on the number of categories you require to handle, you could always use a combination of the finder with the built in label functionality, thus a movie can be held in one area (movies directory, for example), but "tagged" as something else. Using smart directories and saved searches you can view your files by a combination of the attributes (location, label, media type) to create custom views. All without purchasing software. Cheap and cheerful, but may be suitable to your needs.', 'A: Maybe use a file manager that supports Open Meta. Or use symbolic links for organizing all your media files. Or even use hardlinked files if you dare.'], 'topic': 'Discussion on file manager applications for organizing large amount of media files.'}
+```
 
-More information needed
 
-## Training procedure
 
 ### Training hyperparameters
 
@@ -77,4 +91,4 @@ The following hyperparameters were used during training:
 - Transformers 4.35.2
 - Pytorch 2.0.1+cu118
 - Datasets 2.15.0
-- Tokenizers 0.15.0
+- Tokenizers 0.15.0