MexIvanov commited on
Commit
33bbc20
1 Parent(s): fc26b4d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +117 -3
README.md CHANGED
@@ -1,3 +1,117 @@
1
- ---
2
- license: apache-2.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - text-generation-inference
4
+ - text-generation
5
+ - peft
6
+ library_name: transformers
7
+ base_model: mistralai/Mistral-7B-v0.3
8
+ widget:
9
+ - messages:
10
+ - role: user
11
+ content: What is your favorite condiment?
12
+ license: apache-2.0
13
+ language:
14
+ - ru
15
+ - en
16
+ datasets:
17
+ - MexIvanov/RAG-v1-ruen
18
+ ---
19
+
20
+ # Model Card for MistRAG-7B-ruen-v1
21
+
22
+
23
+ ## Model Details
24
+
25
+ ### Model Description
26
+ - **Developed by:** C.B. Pronin
27
+ - **Model type:** GGUF Quantizations of the merged model (MexIvanov/MistRAG-7B-ruen-v1-merged)
28
+ - **Language(s) (NLP):** Russian, English
29
+ - **License:** Apache license 2.0
30
+ - **Finetuned from model:** mistralai/Mistral-7B-v0.3
31
+
32
+ ## Provided files
33
+
34
+ Model for automating question answering tasks specified to RAG pipelines in two languages English and Russian, trained on machine-translated "glaiveai/RAG-v1" dataset.
35
+ GGUF Quantizations for use with projects like ollama and llama.cpp.
36
+
37
+ | Name | Quant method | Bits | Use case |
38
+ | ---- | ---- | ---- | ----- |
39
+ | [MistRAG-7b-v1-f16.gguf](https://huggingface.co/MexIvanov/MistRAG-7B-ruen-v1-gguf/blob/main/MistRAG-7b-v1-f16.gguf) | f16 | 16 | Full F16 weights. |
40
+ | [MistRAG-7b-v1-q8_0.gguf](https://huggingface.co/MexIvanov/MistRAG-7B-ruen-v1-gguf/blob/main/MistRAG-7b-v1-q8_0.gguf) | Q8_0 | 8 | Extremely high quality, generally unneeded but max available quant. |
41
+ | [MistRAG-7b-v1-q6_K.gguf](https://huggingface.co/MexIvanov/MistRAG-7B-ruen-v1-gguf/blob/main/MistRAG-7b-v1-q6_K.gguf) | Q6_K | 6 | | Very high quality, near perfect, *recommended*. |
42
+ | [MistRAG-7b-v1-q5_K_M.gguf](https://huggingface.co/MexIvanov/MistRAG-7B-ruen-v1-gguf/blob/main/MistRAG-7b-v1-q5_K_M.gguf) | Q5_K_M | 5 | High quality, *recommended*. |
43
+ | [MistRAG-7b-v1-q4_K_M.gguf](https://huggingface.co/MexIvanov/MistRAG-7B-ruen-v1-gguf/blob/main/MistRAG-7b-v1-q4_K_M.gguf) | Q4_K_M | 4 | Good quality, default size for must use cases, *recommended*. |
44
+
45
+ ### In-code prompting templates
46
+ ```
47
+ SYSTEM = "You are a conversational AI assistant that is provided a list of documents and a user query to answer based on information from the documents. The user also provides an answer mode which can be 'Grounded' or 'Mixed'. For answer mode Grounded only respond with exact facts from documents, for answer mode Mixed answer using facts from documents and your own knowledge. Cite all facts from the documents using <co: doc_id></co> tags."
48
+ SYSTEM_RU = "Вы — разговорный помощник ИИ, которому предоставляется список документов и запрос пользователя для ответа на основе информации из документов. Пользователь также предоставляет режим ответа, который может быть 'Обоснованный' или 'Смешанный'. Для режима ответа «Обоснованный» отвечайте только точными фактами из документов, для режима ответа «Смешанный» отвечайте, используя факты из документов и собственные знания. Ссылайтесь на все факты из документов, используя теги <co: doc_id></co>."
49
+
50
+ #English prompt template:
51
+ prompt_en = SYSTEM + '\n\n' + documents + '\n\nAnswer Mode: ' + Grounded or Mixed + '\n\nQuestion: ' + question + '\n\nResponse: ' + answer
52
+
53
+ #Russian prompt temlate:
54
+ prompt_ru = SYSTEM_RU + '\n\n' + documents + '\n\nAnswer Mode: ' + Обоснованный или Смешанный + '\n\nQuestion: ' + question_ru + '\n\nResponse: ' + answer_ru
55
+ ```
56
+
57
+ ### English example prompt:
58
+ ```
59
+ You are a conversational AI assistant that is provided a list of documents and a user query to answer based on information from the documents. The user also provides an answer mode which can be 'Grounded' or 'Mixed'. For answer mode Grounded only respond with exact facts from documents, for answer mode Mixed answer using facts from documents and your own knowledge. Cite all facts from the documents using <co: doc_id></co> tags.
60
+
61
+ Document:0 Title: IT Project Failure Rates Text: According to a study published by the Harvard Business Review in 2011, 1 in 6 IT projects experience a cost overrun of 200% and a schedule overrun of nearly 70%. These statistics highlight the significant risk associated with managing IT projects. It is crucial to understand that these problems often begin even before the project is officially initiated. Many issues can be traced back to inadequate planning stages, where necessary precautions and thorough analyses are overlooked. The complexities of IT projects require careful handling of project proposals, client onboarding, and initial scope definitions. Failure to address these preliminary steps can lead to escalated costs and extended timelines, severely impacting the overall success of the project. Document:1 Title: Effective Project Proposal Strategies Text: An essential aspect of project management is the project proposal stage. This stage is critical because it sets the groundwork for all subsequent activities. A well-prepared project proposal can help in clearly defining the project scope, deliverables, and responsibilities, which are crucial for project success. According to project management experts, a project proposal should include a detailed analysis of the client's needs, a comprehensive plan of action, and a clear statement of work. Moreover, it's beneficial to create transparency in roles and responsibilities and to present a timeline that outlines when each project milestone will be achieved. This can significantly reduce misunderstandings and set clear expectations from the outset. Document:2 Title: Historical Overview of Project Management Text: Project management has evolved significantly over the decades. Initially, projects were managed informally using simple techniques. However, as industries grew and projects became more complex, the need for formal project management methodologies became evident. This led to the development of various frameworks and standards that guide today's project management practices. One of the key aspects that have been emphasized in modern project management is the importance of initial planning and client engagement. Early engagement with clients helps in understanding their vision and aligning the project objectives accordingly, which is essential for the successful delivery of the project. Document:3 Title: Client Onboarding and Project Kickoff Text: The process of client onboarding is a critical phase in project management. It involves preparing the client for the project journey ahead and ensuring they are fully informed about the process. Effective onboarding can mitigate many risks associated with project misunderstandings and misalignments. During this phase, project managers should focus on building a strong relationship with the client, clarifying project scopes, and discussing the budget and timeline in detail. This phase sets the tone for the project and can significantly influence its success or failure. Document:4 Title: Role of Technology in Project Management Text: In today's digital age, technology plays a crucial role in project management. From project tracking tools to communication platforms, technology helps in streamlining project processes and enhancing collaboration among team members. Effective use of technology can lead to better project outcomes by providing real-time updates and facilitating easier communication. This is particularly important in IT projects, where requirements can change rapidly, and staying updated is crucial for project success.
62
+
63
+ Answer Mode: Grounded
64
+
65
+ Question: How can the initial stages of IT project management, specifically the project proposal and client onboarding stages, be optimized to prevent the common issues of cost and schedule overruns?
66
+
67
+ Response:
68
+ ```
69
+
70
+ ### Russian example prompt:
71
+ ```
72
+ Вы — разговорный помощник ИИ, которому предоставляется список документов и запрос пользователя для ответа на основе информации из документов. Пользователь также предоставляет режим ответа, который может быть 'Обоснованный' или 'Смешанный'. Для режима ответа «Обоснованный» отвечайте только точными фактами из документов, для режима ответа «Смешанный» отвечайте, используя факты из документов и собственные знания. Ссылайтесь на все факты из документов, используя теги <co: doc_id></co>.
73
+
74
+ Документ:0 Название: Показатели неудач ИТ-проектов Текст: Согласно исследованию, опубликованному Harvard Business Review в 2011 году, 1 из 6 ИТ-проектов перерасходует средства на 200% и выходит за рамки графика почти на 70%. Эти статистические данные подчеркивают значительный риск, связанный с управлением ИТ-проектами. Важно понимать, что эти проблемы часто начинаются еще до официального начала проекта. Многие проблемы можно отследить до неадекватных этапов планирования, когда необходимые меры предосторожности и тщательный анализ упускаются из виду. Сложность ИТ-проектов требует тщательной обработки проектных предложений, привлечения клиентов и начальных определений объема работ. Невыполнение эти�� предварительных шагов может привести к росту затрат и увеличению сроков, что серьезно повлияет на общий успех проекта. Документ:1 Название: Эффективные стратегии предложения проекта Текст: Важным аспектом управления проектами является этап предложения проекта. Этот этап имеет решающее значение, поскольку он устанавливает Основа для всех последующих действий. Хорошо подготовленное проектное предложение может помочь в четком определении объема проекта, результатов и обязанностей, которые имеют решающее значение для успеха проекта. По мнению экспертов по управлению проектами, проектное предложение должно включать подробный анализ потребностей клиента, всеобъемлющий план действий и четкое описание работы. Более того, полезно создать прозрачность в ролях и обязанностях и представить временную шкалу, которая описывает, когда будет достигнут каждый этап проекта. Это может значительно уменьшить недопонимание и установить четкие ожидания с самого начала. Документ:2 Название: Исторический обзор управления проектами Текст: Управление проектами значительно изменилось за десятилетия. Первоначально управление проектами осуществлялось неформально с использованием простых методов. Однако по мере роста отраслей и усложнения проектов стала очевидной потребность в формальных методологиях управления проектами. Это привело к разработке различные структуры и стандарты, которые определяют современные методы управления проектами. Одним из ключевых аспектов, которые подчеркиваются в современном управлении проектами, является важность первоначального планирования и взаимодействия с клиентом. Раннее взаимодействие с клиентами помогает понять их видение и соответствующим образом согласовать цели проекта, что имеет важное значение для успешной реализации проекта. Документ:3 Название: Привлечение клиентов и начало проекта Текст: Процесс привлечения клиентов является критически важным этапом в управлении проектами. Он включает подготовку клиента к предстоящему проектному пути и обеспечение его полной информированности о процессе. Эффективное привлечение может смягчить многие риски, связанные с недопониманием и несоответствиями проекта. На этом этапе менеджеры проектов должны сосредоточиться на построении прочных отношений с клиентом, прояснении объемов проекта и подробном обсуждении бюджета и сроков. Этот этап задает тон для проекта и может значительно влияют на его успех или неудачу. Документ:4 Название: Роль технологий в управлении проектами Текст: В сегодняшнюю цифровую эпоху технологии играют решающую роль в управлении проектами. От инструментов отслеживания проектов до коммуникационных платформ технологии помогают оптимизировать процессы проекта и улучшить сотрудничество между членами команды. Эффективное использование технологий может привести к лучшим результатам проекта за счет предоставления обновлений в режиме реального времени и упрощения коммуникации. Это особенно важно в ИТ-проектах, где требования могут быстро меняться, а поддержание актуальности имеет решающее значение для успеха проекта.
75
+
76
+ Answer Mode: Обоснованный
77
+
78
+ Question: Как можно оптимизировать начальные этапы управления ИТ-проектами, в частности этапы предложения проекта и привлечения клиентов, чтобы предотвратить распространенные проблемы, связанные с превышением затрат и графика?
79
+
80
+ Response:
81
+ ```
82
+
83
+ ### Generation examples:
84
+
85
+ ### Example 1:
86
+ ```
87
+ You are a conversational AI assistant that is provided a list of documents and a user query to answer based on information from the documents. The user also provides an answer mode which can be 'Grounded' or 'Mixed'. For answer mode Grounded only respond with exact facts from documents, for answer mode Mixed answer using facts from documents and your own knowledge. Cite all facts from the documents using <co: doc_id></co> tags.
88
+
89
+ Document:0 Title: IT Project Failure Rates Text: According to a study published by the Harvard Business Review in 2011, 1 in 6 IT projects experience a cost overrun of 200% and a schedule overrun of nearly 70%. These statistics highlight the significant risk associated with managing IT projects. It is crucial to understand that these problems often begin even before the project is officially initiated. Many issues can be traced back to inadequate planning stages, where necessary precautions and thorough analyses are overlooked. The complexities of IT projects require careful handling of project proposals, client onboarding, and initial scope definitions. Failure to address these preliminary steps can lead to escalated costs and extended timelines, severely impacting the overall success of the project. Document:1 Title: Effective Project Proposal Strategies Text: An essential aspect of project management is the project proposal stage. This stage is critical because it sets the groundwork for all subsequent activities. A well-prepared project proposal can help in clearly defining the project scope, deliverables, and responsibilities, which are crucial for project success. According to project management experts, a project proposal should include a detailed analysis of the client's needs, a comprehensive plan of action, and a clear statement of work. Moreover, it's beneficial to create transparency in roles and responsibilities and to present a timeline that outlines when each project milestone will be achieved. This can significantly reduce misunderstandings and set clear expectations from the outset. Document:2 Title: Historical Overview of Project Management Text: Project management has evolved significantly over the decades. Initially, projects were managed informally using simple techniques. However, as industries grew and projects became more complex, the need for formal project management methodologies became evident. This led to the development of various frameworks and standards that guide today's project management practices. One of the key aspects that have been emphasized in modern project management is the importance of initial planning and client engagement. Early engagement with clients helps in understanding their vision and aligning the project objectives accordingly, which is essential for the successful delivery of the project. Document:3 Title: Client Onboarding and Project Kickoff Text: The process of client onboarding is a critical phase in project management. It involves preparing the client for the project journey ahead and ensuring they are fully informed about the process. Effective onboarding can mitigate many risks associated with project misunderstandings and misalignments. During this phase, project managers should focus on building a strong relationship with the client, clarifying project scopes, and discussing the budget and timeline in detail. This phase sets the tone for the project and can significantly influence its success or failure. Document:4 Title: Role of Technology in Project Management Text: In today's digital age, technology plays a crucial role in project management. From project tracking tools to communication platforms, technology helps in streamlining project processes and enhancing collaboration among team members. Effective use of technology can lead to better project outcomes by providing real-time updates and facilitating easier communication. This is particularly important in IT projects, where requirements can change rapidly, and staying updated is crucial for project success.
90
+
91
+ Answer Mode: Grounded
92
+
93
+ Question: How can the initial stages of IT project management, specifically the project proposal and client onboarding stages, be optimized to prevent the common issues of cost and schedule overruns?
94
+
95
+ Response:
96
+
97
+ Cited Documents: 0, 1
98
+
99
+ Answer: <co:0>IT projects often suffer from high failure rates due to issues that begin even in the initial planning stages, where necessary precautions and analyses are overlooked.</co> <co:1>An effective project proposal should include a detailed analysis of the client's needs, a comprehensive plan of action, and a clear statement of work, which can help define the project scope and deliverables more clearly and reduce misunderstandings.</co> By focusing on these stages and ensuring a strong client engagement and understanding of project objectives, project managers can significantly reduce the risks associated with cost and schedule overruns.
100
+ ```
101
+
102
+ ### Example 2:
103
+ ```
104
+ Вы — разговорный помощник ИИ, которому предоставляется список документов и запрос пользователя для ответа на основе информации из документов. Пользователь также предоставляет режим ответа, который может быть 'Обоснованный' или 'Смешанный'. Для режима ответа «Обоснованный» отвечайте только точными фактами из документов, для режима ответа «Смешанный» отвечайте, используя факты из документов и собственные знания. Ссылайтесь на все факты из документов, используя теги <co: doc_id></co>.
105
+
106
+ Документ:0 Название: Показатели неудач ИТ-проектов Текст: Согласно исследованию, опубликованному Harvard Business Review в 2011 году, 1 из 6 ИТ-проектов перерасходует средства на 200% и выходит за рамки графика почти на 70%. Эти статистические данные подчеркивают значительный риск, связанный с управлением ИТ-проектами. Важно понимать, что эти проблемы часто начинаются еще до официального начала проекта. Многие проблемы можно отследить до неадекватных этапов планирования, когда необходимые меры предосторожности и тщательный анализ упускаются из виду. Сложность ИТ-проектов требует тщательной обработки проектных предложений, привлечения клиентов и начальных определений объема работ. Невыполнение этих предварительных шагов может привести к росту затрат и увеличению сроков, что серьезно повлияет на общий успех проекта. Документ:1 Название: Эффективные стратегии предложения проекта Текст: Важным аспектом управления проектами является этап предложения проекта. Этот этап имеет решающее значение, поскольку он устанавливает Основа для всех последующих действий. Хорошо подготовленное проектное предложение может помочь в четком определении объема проекта, результатов и обязанностей, которые имеют решающее значение для успеха проекта. По мнению экспертов по управлению проектами, проектное предложение должно включать подробный анализ потребностей клиента, всеобъемлющий план действий и четкое описание работы. Более того, полезно создать прозрачность в ролях и обязанностях и представить временную шкалу, которая описывает, когда будет достигнут каждый этап проекта. Это может значительно уменьшить недопонимание и установить четкие ожидания с самого начала. Документ:2 Название: Исторический обзор управления проектами Текст: Управление проектами значительно изменилось за десятилетия. Первоначально управ��ение проектами осуществлялось неформально с использованием простых методов. Однако по мере роста отраслей и усложнения проектов стала очевидной потребность в формальных методологиях управления проектами. Это привело к разработке различные структуры и стандарты, которые определяют современные методы управления проектами. Одним из ключевых аспектов, которые подчеркиваются в современном управлении проектами, является важность первоначального планирования и взаимодействия с клиентом. Раннее взаимодействие с клиентами помогает понять их видение и соответствующим образом согласовать цели проекта, что имеет важное значение для успешной реализации проекта. Документ:3 Название: Привлечение клиентов и начало проекта Текст: Процесс привлечения клиентов является критически важным этапом в управлении проектами. Он включает подготовку клиента к предстоящему проектному пути и обеспечение его полной информированности о процессе. Эффективное привлечение может смягчить многие риски, связанные с недопониманием и несоответствиями проекта. На этом этапе менеджеры проектов должны сосредоточиться на построении прочных отношений с клиентом, прояснении объемов проекта и подробном обсуждении бюджета и сроков. Этот этап задает тон для проекта и может значительно влияют на его успех или неудачу. Документ:4 Название: Роль технологий в управлении проектами Текст: В сегодняшнюю цифровую эпоху технологии играют решающую роль в управлении проектами. От инструментов отслеживания проектов до коммуникационных платформ технологии помогают оптимизировать процессы проекта и улучшить сотрудничество между членами команды. Эффективное использование технологий может привести к лучшим результатам проекта за счет предоставления обновлений в режиме реального времени и упрощения коммуникации. Это особенно важно в ИТ-проектах, где требования могут быстро меняться, а поддержание актуальности имеет решающее значение для успеха проекта.
107
+
108
+ Answer Mode: Grounded
109
+
110
+ Question: Как можно оптимизировать начальные этапы управления ИТ-проектами, в частности этапы предложения проекта и привлечения клиентов, чтобы предотвратить распространенные проблемы, связанные с превышением затрат и графика?
111
+
112
+ Response:
113
+
114
+ Ссылающиеся документы: 0, 1, 3
115
+
116
+ Ответ: Чтобы оптимизировать начальные этапы управления ИТ-проектами и предотвратить распространенные проблемы, связанные с превышением затрат и графика, необходимо уделить особое внимание этапам предложения проекта и привлечения клиентов. <co:0>Исследование Harvard Business Review показало, что 1 из 6 ИТ-проектов перерасходует средства на 200% и выйдет за рамки графика почти на 70%, что часто связано с неадекватными этапами планирования, необходимыми меры предосторожности и тщательный анализ.</co> Это подчеркивает важность тщательного анализа потребностей клиента и тщате��ьного планирования в предложении проекта. <co:1>Хорошо подготовленное проектное предложение может помочь в четком определении объема проекта, результатов и обязанностей, что имеет решающее значение для успеха проекта.</co> Кроме того, <co:3>эффективное привлечение клиентов помогает понять их видение и согласовывать цели проекта, что может значительно смягчить недопонимание и установить четкие ожидания с самого начала.</co> Эти стратегические шаги в начале проекта могут значительно снизить риск перерасхода средств и увеличения сроков, повысив общий успех проекта.
117
+ ```