jaeyong2
/

Chunk-Generator-Preview

@@ -1,199 +1,71 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
 library_name: transformers
+language:
+- en
 ---
+## Virtual Cleint
+<p align="center">
+  <img src="client.png" alt="client" width="400"/>
+</p>
+### example
+```
+from transformers import AutoModelForCausalLM, AutoTokenizer
+model_name = "jaeyong2/Chunk-Generator-Preview"
+model = AutoModelForCausalLM.from_pretrained(model_name)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+prompt = """
+You are an AI that receives a document as input and divides it into chunks for application to RAG.
+You divide the document into chunks, and you must divide it according to the following conditions.
+1. You must set the chunk index according to the position in the document.
+2. When chunks are combined, they must contain the same information as the document.
+3. When creating chunks, if there is information outside the chunk (e.g., pronouns like "it", "he", or "she"), fill in the necessary information from the document.
+4. Therefore, there should be no unknown information within the chunk.
+Output format: JSON
+```json
+{
+    "chunk1":"...",
+    "chunk2":"...",
+    ...
+}
+```
+""".strip()
+content ="""
+On this day in 1784, at the Maryland State House in Annapolis, the Continental Congress ratifies the Treaty of Paris. The document, negotiated in part by future President John Adams, contained terms for ending the Revolutionary War and established the United States as a sovereign nation. The treaty outlined America's fishing rights off the coast of Canada, defined territorial boundaries in North America formerly held by the British and forced an end to reprisals against British loyalists. Two other future presidents, Thomas Jefferson and James Monroe, were among the delegates who ratified the document on January 14, 1874.
+Thomas Jefferson had planned to travel to Paris to join Adams, John Jay and Benjamin Franklin for the beginning of talks with the British in 1782. However, after a delay in his travel plans, Jefferson received word that a cessation of hostilities had been announced by King George III the previous December. Jefferson arrived in Paris in late February after the treaty had already been negotiated by Adams, Franklin and Jay.
+Adams' experience and skill in diplomacy prompted Congress to authorize him to act as the United States' representative in negotiating treaty terms with the British. Following his role in ending the Revolutionary War and his participation in drafting the Declaration of Independence, Adams succeeded George Washington as the second president of the United States in 1797.
+""".strip()
+system = {"role":"system", "content":prompt}
+user = {"role":"user", "content":content}
+messages = [system, user]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True,
+    enable_thinking=False # Switches between thinking and non-thinking modes. Default is True.
+)
+model_inputs = tokenizer([text], return_tensors="pt").to(model.device)
+# conduct text completion
+generated_ids = model.generate(
+    **model_inputs,
+    max_new_tokens=32768
+)
+output_ids = generated_ids[0][len(model_inputs.input_ids[0]):].tolist()
+content = tokenizer.decode(output_ids, skip_special_tokens=True).strip("\n")
+```
+### result
+```
+content: {
+    "chunk1": "On this day in 1784, at the Maryland State House in Annapolis, the Continental Congress ratifies the Treaty of Paris. The document, negotiated in part by future President John Adams, contained terms for ending the Revolutionary War and established the United States as a sovereign nation. The treaty outlined America's fishing rights off the coast of Canada, defined territorial boundaries in North America formerly held by the British and forced an end to reprisals against British loyalists. Two other future presidents, Thomas Jefferson and James Monroe, were among the delegates who ratified the document on January 14, 1874.",
+    "chunk2": "Thomas Jefferson had planned to travel to Paris to join Adams, John Jay and Benjamin Franklin for the beginning of talks with the British in 1782. However, after a delay in his travel plans, Jefferson received word that a cessation of hostilities had been announced by King George III the previous December. Jefferson arrived in Paris in late February after the treaty had already been negotiated by Adams, Franklin and Jay.",
+    "chunk3": "Adams' experience and skill in diplomacy prompted Congress to authorize him to act as the United States' representative in negotiating treaty terms with the British. Following his role in ending the Revolutionary War and his participation in drafting the Declaration of Independence, Adams succeeded George Washington as the second president of the United States in 1797."
+}
+```